Update release.md

This commit is contained in:
Thomas Tendyck 2023-05-05 09:08:39 +02:00
parent c3b13178aa
commit 17c45bc881

View File

@ -24,7 +24,7 @@ Releases should be performed using [the automated release pipeline](https://gith
```
3. wait for the pipeline to finish
4. while in editing mode for the release, clear the textbox, select the last patch release for the current release branch and click "Generate release notes".
5. look over the autogenerated draft release. When fixing the changelog, prioritize updating the PR title/labels/description and regenerating the changelog over fixing things in the final changelog.
5. look over the autogenerated draft release. When fixing the changelog, prioritize updating the PR title/labels/description and regenerating the changelog over fixing things in the final changelog. The changelog should be primarily aimed at users. Rule of thumb: first part of the sentence should describe what changed for the user, second part can describe what has been changed to achieve this.
6. publish.
### Minor release
@ -37,17 +37,18 @@ Releases should be performed using [the automated release pipeline](https://gith
```
3. wait for the pipeline to finish
4. while in editing mode for the release, clear the textbox, select the last minor release and click "Generate release notes".
5. look over the autogenerated draft release. When fixing the changelog, prioritize updating the PR title/labels/description and regenerating the changelog over fixing things in the final changelog.
5. look over the autogenerated draft release. When fixing the changelog, prioritize updating the PR title/labels/description and regenerating the changelog over fixing things in the final changelog. The changelog should be primarily aimed at users. Rule of thumb: first part of the sentence should describe what changed for the user, second part can describe what has been changed to achieve this.
6. publish.
## Post release steps
1. Milestones management
1. Close fixed "known issues"
2. Milestones management
1. Create a new milestone for the next release
2. Add the next release manager and an approximate release date to the milestone description
3. Close the milestone for the release
4. Move open issues and PRs from closed milestone to next milestone
2. If the release is a minor version release, bump the pre-release version in the `version.txt` file.
3. If the release is a minor version release, bump the pre-release version in the `version.txt` file.
## Pipeline cleanup