Document the release process #2371
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
intgr
commented
Sep 13, 2024
CONTRIBUTING.md
Outdated
|
|
||
| `patch` is sequentially increasing for each stubs release. Reset to `0` if `major.minor` was updated. | ||
|
|
||
| - Use pull request title "Version x.y.z release" by convention. |
There was a problem hiding this comment.
I notice now that flaeppe has been using PR title "Prepare for a release `5.0.1`". I don't have strong feelings either way. Except for the fact that the "a" there seems ungrammatical and can be omitted.
intgr
force-pushed
the
document-releases
branch
from
bb9de49
to
8f2a4d9
Compare
intgr
commented
Sep 13, 2024
Comment on lines
+145
to
+146
| - Delete all release notes lines containing `by @pre-commit-ci` or `by @dependabot`, as these | ||
| are irrelevant for our users. |
There was a problem hiding this comment.
Haven't done this for the last few releases. It's an additional manual step, but IMO release notes are too noisy if these are included.
flaeppe
approved these changes
Sep 14, 2024
|
Great that we get a release flow documented |
Tweak phrasing & reorder bullet points.
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.
This is my vision of how the release process looks like.
See rendered Markdown here.
Pinging @flaeppe as the one who has made all the latest releases.
Related issues
5.0.1#2183 (comment)