Update the release checklist #1075
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As discussed, we wanted to make small amendments to the release process, so that we have a 0.N.0 commit on main. I also adjusted the wording here and there. There were some open questions, which I have marked with a FIXME. Please let me know how to proceed with those.
|
The documentation is not available anymore as the PR was closed or merged. |
pacman100
reviewed
Nov 6, 2023
There was a problem hiding this comment.
Thank you @BenjaminBossan for updating the release checklist! Have replied to the FIXME parts. Good to merge once those are addressed
setup.py
Outdated
| # Push the tag to git: | ||
| # git push --tags origin main | ||
| # It is necessary to work on the original repository, not on a fork. | ||
| # FIXME should we create an annotated tag: git tag -a ... |
There was a problem hiding this comment.
Yes, let's use annotated tag as it is more informative and better for public releases
setup.py
Outdated
| # git push --tags origin main | ||
| # It is necessary to work on the original repository, not on a fork. | ||
| # FIXME should we create an annotated tag: git tag -a ... | ||
| # FIXME we can also skip this and let GH release create the tag for us |
There was a problem hiding this comment.
Let's explicitly have the tag step before release.
setup.py
Outdated
| # twine upload dist/* -r pypitest | ||
| # twine upload dist/* -r pypitest --repository-url=https://test.pypi.org/legacy/ | ||
| # 6. Check that you can install it in a virtualenv by running: | ||
| # FIXME are both commands needed? I think not |
There was a problem hiding this comment.
Yes, I think the second one isn't required
|
@pacman100 I updated the PR according to your comments, please check again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed, we wanted to make small amendments to the release process, so that we have a 0.N.0 commit on main. I also adjusted the wording here and there.
There were some open questions, which I have marked with a
FIXME. Please let me know how to proceed with those.Note: For me, the GitHub diff view is not correct, so please check the changes carefully.