Skip to content

Commit 00db21a

Browse files
authored
Merge pull request #1678 from wwentland/release-note-content
📖 Clarify release notes content for releases and pre-releases
2 parents 739fbe3 + 2d23974 commit 00db21a

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

RELEASE.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ to version 1.2.3 would be called `v1.2.3-rc.0`.
2727

2828
It is recommended to create at least one release candidate when bumping `X` or `Y`.
2929

30+
## Release notes
31+
32+
Release notes are user visible information providing details of all relevant changes between releases.
33+
34+
The content of the release notes differs depending on the type of release, specifically:
35+
36+
- Stable releases contain a *full* changelog from the last stable release.
37+
- Pre-releases contain a changelog from the previous pre-release, or the last stable release if there isn't one.
38+
3039
## Process
3140

3241
1. Make sure your repo is clean by git's standards. It is recommended to use a fresh checkout.
@@ -60,10 +69,12 @@ It is recommended to create at least one release candidate when bumping `X` or `
6069
It is good practise to get somebody else to review this PR. It is safe to perform the following steps while waiting
6170
for review and the promotion of the image.
6271
1. Run `make release` to build artifacts to be attached to the GitHub release.
63-
1. Generate and finalize the release notes and save them for the next step:
64-
- Run `make release-notes` to gather changes since the last revision. If you need to specify a specific tag to look for changes
65-
since, use `make release-notes RELEASE_NOTES_ARGS="--from <tag>"`.
66-
- Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted.
72+
1. Generate and finalize the release notes and save them for the next step.
73+
- Run `make release-notes RELEASE_NOTES_ARGS="--from <tag>"`.
74+
- Depending on the type of release, substitute `<tag>` with the following:
75+
- Stable releases: tag of the last stable release
76+
- Pre-releases*: tag of the latest pre-release (or last stable release if there isn't one)
77+
- Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted.
6778
1. Create a draft release in GitHub based on the tag created above
6879
- Name the release `Release [VERSION]` where VERSION is the full version string.
6980
- For a pre-release, ensure you check `This is a pre-release` in GitHub when creating the release.

0 commit comments

Comments
 (0)