Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(release): simplify management of GH releases #2836

Merged
merged 3 commits into from
Aug 29, 2023
+2 −2
Merged

docs(release): simplify management of GH releases #2836

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7628c7
docs(release): simplify management of GH releases
tbouffard Aug 29, 2023
1d6f110
improve wording
tbouffard Aug 29, 2023
3200b9f
Merge branch 'master' into docs/release_simplify_gh_release_management
tbouffard Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/contributors/maintainers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ are automated once the release is triggered but manual actions are required for:
- [release-drafter](https://github.com/release-drafter/release-drafter) creates or updates draft release for the
next version each time a pull request is merged to the `master` branch.
- Rename the existing draft release to `In Progress`. The name is not relevant and will be later used to identify the draft release to update.
- If an old `Notes for next release notes` exists, put its content in the `In Progress` release to later help to write the details. Then, delete this release.
- Create a new draft release and name it `Notes for next release notes`. It will be used during development to note important things and prepare
- If no `Notes for next release notes` draft release exists, create a new one. It will be used during development to note important things and prepare
the content of the next release notes.
- Create a new draft release and name it `Next` (the name is not relevant and will be replaced automatically later).
This ensures that development can continue without impacting the writing of the content of the `In Progress` release. That way,
Expand Down Expand Up @@ -83,6 +82,7 @@ ___
- In the release description (check previous releases as a source of inspiration)
- at least add/update a link to the related milestone
- put screenshots/gif of the new features
- Use the content of the `Notes for next release notes` draft release to write the description. Keep the unrelated content in this draft release.
- Assign the new tag as release target and save the draft (this may have been already managed by `release-drafter`). **Do it only just before
publishing** especially if you update an already set tag for minor version. Once you change the tag and save, the update date of the release
is updated making it the newest one. This is the one that is updated by release-drafter so there is a risk to loose the whole content of
Expand Down