chore: improve the release instructions #76
Conversation
WilliamBergamin
added
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #76 +/- ##
=======================================
Coverage 94.68% 94.68%
=======================================
Files 11 11
Lines 207 207
=======================================
Hits 196 196
Misses 11 11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
@WilliamBergamin LGTM! Thanks for formatting these lines too 🙏 ✨
I left a comment to discuss development releases more and I'm curious what you think? I find the specs aren't so clear when using a patch version...
| - Example: if the current version is `1.2.3`, a proper development bump would be `1.2.4.dev0` | ||
| - `.dev` will indicate to pip that this is a [Development Release](https://peps.python.org/pep-0440/#developmental-releases) | ||
| - Note that the `dev` version can be bumped in development releases: `1.2.4.dev0` -> `1.2.4.dev1` |
There was a problem hiding this comment.
👾 question: Would we still want this to be development releases for the next minor version?
1.3.0.dev0
🗣️ ramble: Some confusion exists for projects IMHO where we've tagged patch release RCs that end up released under the next minor version - I understand these RCs most common for major or minor versions!
There was a problem hiding this comment.
I think it depends on the changes included in the development version, if the changes are scoped to a minor then we should bump the minor version rather then the patch, example 1.2.3 would become 1.3.0.dev0
what is found in the maintainers guide is an example, but the maintainer performing the release should use their judgment to determine the correct semver version 🧠
Summary
This PR improves the release instructions so that they aline with the ones found in the Bolt and SDK projects
Testing
N/A
Requirements
./scripts/install_and_run_tests.shafter making the changes.