Update release checklist #347
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
jbreue16
force-pushed
the
fix/release_checklist
branch
from
a284126 to
6c112e8
Compare
schmoelder
reviewed
Dec 13, 2024
schmoelder
reviewed
Dec 13, 2024
| @@ -10,7 +10,7 @@ CADET-Core release | |||
| CADET-Core releases follow the *semantic versioning system*, which is documented [here](https://semver.org/). | |||
|
|
|||
| **CADET-Core is released following the so-called *GitLab flow*:** | |||
| In GitLab flow, feature and hotfix branches contain work for new features and bug fixes which will be merged back into the master branch immediately when they’re finished, reviewed, and approved. The master branch is ready to be deployed, but not necessarily the source of truth for a new release: Each release has an associated release branch that is based off the master branch. Changes that are intended to be released are cherry-picked from master into the release branch. The release is made on the release branch. If desired, some release branches can be kept and maintained, which is currently not planned for the CADET-Core project. | |||
| In GitLab flow, feature and hotfix branches contain work for new features and bug fixes which will be merged back into the master branch immediately when they’re finished, reviewed, and approved. The master branch is ready to be deployed, but not necessarily the source of truth for a new release: Each release has an associated release branch that is based off the master branch. Changes that are intended to be released are cherry-picked from master onto the release branch. The release is made on the release branch. Some release branches can be kept and maintained, e.g. branch `v5.0.X` to support the last major release. | |||
There was a problem hiding this comment.
last major release
Wouldn't v5.0.X be there to maintain the latest minor release?
Side note: using individual lines for each sentence would make reviews a bit more conveninent
There was a problem hiding this comment.
v5.2.X would support a minor release; v5.0.X supports the major release, right?
I know, usually I would make a single line for each sentence, but there was a reason against linebreaks, maybe the import from the rst file.
schmoelder
requested changes
Dec 13, 2024
Co-authored-by: Johannes Schmölder <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Updates according to our experience with the last release #345