Update release guide #167
Merged
Update release guide #167
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
lancerts
previously approved these changes
Aug 29, 2024
ByronHsu
requested changes
Aug 29, 2024
CONTRIBUTING.md
Outdated
| 3. Create a new release based on the current HEAD | ||
| 4. New pip uploading will be triggered upon a new release | ||
| 3. Create a new release based on the current HEAD, tag name using `v<version number>` for example `v0.2.0`. Alternatively, If you want to create release based on a different commit hash, `git tag v0.2.0 <commit hash> && git push origin v0.2.0`, and create release based on this tag | ||
| 4. New pip uploading will be triggered upon a new release. NOTE: Both pre-release and official release will trigger the workflow to build wheel and publish to pypi, so please be sure that step 1-3 are followed correctly! |
There was a problem hiding this comment.
so say if i pre-release one, then official release will conflict with the pre one because it already exists?
There was a problem hiding this comment.
yup as soon as pre-release is out, the build & upload workflow will be triggered. When converting from pre-release to official release, no workflow will be fired. Feeling it would be nice if we could modify the workflow to make it run only for official release 🤔
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.
Summary
conclude some learnings from this release :D
Testing Done
make testto ensure correctnessmake checkstyleto ensure code stylemake test-convergenceto ensure convergence