You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: RELEASE_CHECKLIST.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ If you are releasing a beta or a release candidate, no official changelog is nee
27
27
1. Update the version in `Cargo.toml`.
28
28
1. Run `cargo update`.
29
29
1. Run `cargo test --workspace`.
30
-
1.Run `cargo build --release`.
30
+
1.Make sure you have `npm` installed, and run `cargo build`.
31
31
32
32
### Start a release PR
33
33
@@ -39,14 +39,14 @@ If you are releasing a beta or a release candidate, no official changelog is nee
39
39
40
40
Most review comments will be about the changelog. Once the PR is finalized and approved:
41
41
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.
44
43
45
44
### Tag and build release
46
45
47
46
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.
48
47
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)
50
50
1. Run `git push --tags`.
51
51
1. Wait for CI to pass.
52
52
@@ -62,7 +62,7 @@ After CI builds the release binaries and they appear on the [releases page](http
62
62
63
63
#### If this is a release candidate
64
64
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.
66
66
1. If this is a new rc (rc.0), paste testing instructions into the release notes.
67
67
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:
0 commit comments