Skip to content

Commit b9f66e7

Browse files
docs(release-checklist): include This release includes crate, … in the CHANGELOG, too (#8063)
1 parent 1b948fb commit b9f66e7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/release-checklist.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,17 @@ Day of Release:
7474
- On _your own branch_ based on the latest release branch. Cherry-pick the PRs that need to be backported. When modifying the commits, use --append to retain their original authorship.
7575
- Remove the `needs-backport` label from the PRs.
7676
- Fix the changelogs items and add a new header for the patch release with the release version and date.
77+
- The release section should start with a header saying the following (for example)
78+
```markdown
79+
This release includes `crate1`, `crate2` and `crate3` version `X.Y.Z`. All other crates remain at their previous versions.
80+
```
7781
- Once all the PRs are cherry-picked, look at the diff between HEAD and the previous patch release. See what crates changed.
7882
- Bump all the versions of the crates that changed.
7983
- Create a PR with all of the version changes and changelog updates into the release branch.
8084
- Once the PR is CI clean, (force) rebase merge it.
8185
- Checkout the release branch with the merged PR.
8286
- Publish all relevant crates (see list above).
8387
- Create a new release on the `wgpu` repo with the changelog and a tag called `vX.Y.Z` on the release branch.
84-
- The release should start with a header saying the following (for example)
85-
```markdown
86-
This release includes `crate1`, `crate2` and `crate3` version `X.Y.Z`. All other crates remain at their previous versions.
87-
```
8888
- Backport the changelog and version bumps to the `trunk` branch.
8989
- Ensure that any items in the newly-released changelog don't appear in the "unreleased" section of the trunk changelog.
9090
- Update the release checklist with any needed changes.

0 commit comments

Comments
 (0)