Document automated release process #154
Open
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
ten3roberts
force-pushed
the
fix-release-process
branch
from
efe8d1d to
1922916
Compare
ten3roberts
force-pushed
the
fix-release-process
branch
from
1922916 to
5aa7132
Compare
ten3roberts
requested review from
thenorili and
yaahc
and removed request for
thenorili
ten3roberts
added
C-documentation
ten3roberts
commented
Feb 2, 2024
| role only requires good faith and a basic understanding of our development | ||
| process. | ||
|
|
||
| [Discord]: https://discord.gg/z94RqmUTKB | ||
| [^1]: Okay, I'll admit it, it's really just the Rust Project's CoC :sweat_smile: | ||
|
|
||
| # Release Process |
There was a problem hiding this comment.
We can always refine this, but we need something out now and ensure that releases go smoothly and don't drop commits
thenorili
reviewed
Feb 4, 2024
| The `master` branch contains all the latest changes and is considered unstable. | ||
|
|
||
| For each bugfix and non-breaking change, the relevant commits are cherry-picked to relevant stable release branches, | ||
| denoted by `releas-<major>.<minor>`. A new version is then published from each of the relevant stable release branches. |
Comment on lines
+191
to
+192
| highly encouraged, but not strictly required. The changelog *should not* be maintained on the stable release branches or | ||
| in the release commits, as this leads to them not being visible on the `master` branch. |
There was a problem hiding this comment.
Could you please explain in more detail what you mean by "The changelog should not be maintained on the stable release branches or in the release commits, as this leads to them not being visible on the master branch."?
It's more important for users to have a changelog for releases than to have a changelog for master.
An automated changelog for releases would be fine if we can get that working.
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.
No description provided.