Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release] Update 0.3.1 #324

Open
9 of 20 tasks
skim0119 opened this issue Sep 9, 2023 · 0 comments
Open
9 of 20 tasks

[Release] Update 0.3.1 #324

skim0119 opened this issue Sep 9, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@skim0119
Copy link
Collaborator

skim0119 commented Sep 9, 2023

Release Checklist for Version Update PR

  • Merge (and push) update-dependencies branch
  • Final check README and CONTRIBUTING.
  • Bump LICENSE year (If needed)
  • Bump version (pyproject.toml)
  • Check poetry.lock version match with pyproject.toml
  • Move all the pending PR to next version

Test

  • Run the tests
  • Run the formatting
  • CI Check
make test

Build / Installation

  • Check if local installation can be done.
conda create --name temp
conda activate temp
conda install python==<version>
which pip
make poetry-download
make install

Documentation and Website

  • Check all documentations are updated
- BEYOND THIS, EACH STEP SHOULD BE DONE IN SERIAL (STEP_BY_STEPS). -

Last Edit

  • Rebase the commit history (should be done by only one person) before the PR. (Not required)

Update

  1. Merge the branch to main
  2. Release on github. It should automatically upload pypi

Post-release Checklist

  • Update RELEASE.md - It should be in based on milestone description.
  • Commit the changes:
git add RELEASE.md
git commit -m "Changelog for upcoming release <version>"

Final Check

  • Test that it pip installs
  • Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly.
  • Edit the release-page on GitHub. Paste the release notes with a title for the release.
  • Check Codcov and make sure they are running.
@skim0119 skim0119 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 9, 2023
@skim0119 skim0119 self-assigned this Sep 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant