Skip to content

Commit b5df22e

Browse files
committed
manually cherry-pick cefe990
1 parent 52bb5f8 commit b5df22e

File tree

1 file changed

+13
-6
lines changed
  • docs/release/role-handbooks/communications

1 file changed

+13
-6
lines changed

docs/release/role-handbooks/communications/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,22 @@ The goal of this task is to keep the CAPI community updated on recent PRs that h
8383

8484
### Create PR for release notes
8585
1. Checkout the `main` branch.
86-
1. Generate release notes with:
86+
2. Generate release notes with:
8787

88+
1. RELEASE CANDIDATE/BETA RELEASE example:
8889
```bash
8990
# RELEASE_TAG should be the new desired tag (note: at this point the tag does not yet exist).
90-
# Can be also used for pre-releases. The warning banner for RC and beta releases will be determined automatically.
91-
RELEASE_TAG=v1.6.x make release-notes
91+
# PREVIOUS_RELEASE_TAG is the previous released tag for determining the changes.
92+
RELEASE_TAG=v1.7.x-rc.1 PREVIOUS_RELEASE_TAG=tags/v1.7.x-rc.0 make release-notes
93+
```
94+
**Note**: For a first pre-release version without a pre-release precedent, use above command without `PREVIOUS_RELEASE_TAG`.
95+
2. STABLE RELEASE example
96+
```bash
97+
# RELEASE_TAG should be the new desired tag (note: at this point the tag does not yet exist).
98+
RELEASE_TAG=v1.7.x make release-notes
9299
```
93100

94-
1. This will generate a new release notes file at `CHANGELOG/<RELEASE_TAG>.md`. Finalize the release notes:
101+
3. This will generate a new release notes file at `CHANGELOG/<RELEASE_TAG>.md`. Finalize the release notes:
95102
- [ ] Look for any `MISSING_AREA` entries. Add the corresponding label to the PR and regenerate the notes.
96103
- [ ] Look for any `MULTIPLE_AREAS` entries. If the PR does indeed guarantee multiple areas, just remove the `MULTIPLE_AREAS` prefix and just leave the areas. Otherwise, fix the labels in the PR and regenerate the notes.
97104
- [ ] Review that all areas are correctly assigned to each PR. If not, correct the labels and regenerate the notes.
@@ -104,8 +111,8 @@ The goal of this task is to keep the CAPI community updated on recent PRs that h
104111
- [ ] Sort manually all entries if you made any manual edits that might have altered the correct order.
105112
- [ ] **For minor releases:** Modify `Changes since v1.x.y` to `Changes since v1.x`
106113
<br>**Note**: The release notes tool includes all merges since the previous release branch was branched of.
107-
1. Checkout `main`, branch out from it and add `CHANGELOG/<RELEASE_TAG>.md`.
108-
1. Open a pull request **against the main branch** with all manual edits to `CHANGELOG/<RELEASE_TAG>.md` which is used for the new release notes. The commit and PR title should be `🚀 Release v1.x.y`.
114+
4. Checkout `main`, branch out from it and add `CHANGELOG/<RELEASE_TAG>.md`.
115+
5. Open a pull request **against the main branch** with all manual edits to `CHANGELOG/<RELEASE_TAG>.md` which is used for the new release notes. The commit and PR title should be `🚀 Release v1.x.y`.
109116
<br>**Note**: Important! The commit should only contain the release notes file, nothing else, otherwise automation will not work.
110117

111118

0 commit comments

Comments
 (0)