Skip to content

Commit b479102

Browse files
authored
chore(release-docs): updates to release checklist
- clarifies cargo manifest instructions to run `cargo build` instead of `cargo build --release` - clarifies tagging and release PR instructions
1 parent 86c61d9 commit b479102

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

RELEASE_CHECKLIST.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you are releasing a beta or a release candidate, no official changelog is nee
2727
1. Update the version in `Cargo.toml`.
2828
1. Run `cargo update`.
2929
1. Run `cargo test --workspace`.
30-
1. Run `cargo build --release`.
30+
1. Make sure you have `npm` installed, and run `cargo build`.
3131

3232
### Start a release PR
3333

@@ -39,14 +39,14 @@ If you are releasing a beta or a release candidate, no official changelog is nee
3939

4040
Most review comments will be about the changelog. Once the PR is finalized and approved:
4141

42-
1. If you made changes, squash or fixup all changes into a single commit.
43-
1. Run `git push` and wait for CI to pass.
42+
1. If you made changes, squash or fixup all changes into a single commit. Use the `Squash and Merge` github button.
4443

4544
### Tag and build release
4645

4746
This part of the release process is handled by GitHub Actions, and our binaries are distributed as GitHub Releases. When you push a version tag, it kicks off an action that creates a new GitHub release for that tag, builds release binaries and attaches them to the release.
4847

49-
1. Once ready to merge, tag the commit by running either `git tag -a v#.#.# -m #.#.#` (release), or `git tag -a v#.#.#-rc.# -m #.#.#` (release candidate)
48+
1. Once ready to merge, checkout `main` branch locally and pull latest changes.
49+
1. Tag the commit by running either `git tag -a v#.#.# -m "#.#.#"` (release), or `git tag -a v#.#.#-rc.# -m "#.#.#-rc.#"` (release candidate)
5050
1. Run `git push --tags`.
5151
1. Wait for CI to pass.
5252

@@ -62,7 +62,7 @@ After CI builds the release binaries and they appear on the [releases page](http
6262

6363
#### If this is a release candidate
6464

65-
1. CI should already mark the release as a `pre-release`. Double check that it's listed as a pre-release on the release's Edit page.
65+
1. CI should already mark the release as a `pre-release`. Double check that it's listed as a pre-release on the release's `Edit` page.
6666
1. If this is a new rc (rc.0), paste testing instructions into the release notes.
6767
1. If this is a rc.1 or later, the old release candidate testing instructions should be moved to the latest release candidate testing instructions, and replaced with the following message:
6868

0 commit comments

Comments
 (0)