Skip to content

Commit 9db129e

Browse files
committed
chore: Update release instructions
1 parent 74c9f77 commit 9db129e

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

rust/stackablectl/RELEASE.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ to be done:
66
1. Ensure your local `main` branch is up-to-date and then proceed to checkout a new branch using
77
`git checkout -b chore/release-stackablectl-X.Y.Z`.
88
2. Update both the Cargo.toml and CHANGELOG.md file to the new version `X.Y.Z`.
9-
3. Update various files by running the following xtask `cargo xtask gen-man` and
9+
3. Add the relevant changes from the changelog to a new release notes partial under
10+
`docs/stackablectl/partials/release-notes`.
11+
4. Update various files by running the following xtask `cargo xtask gen-man` and
1012
`make regenerate-nix`. This is also automatically done if pre-commit is enabled.
11-
4. Push the changes and raise a PR.
12-
5. Merge the PR onto `main` and then proceed to tag the appropriate commit using
13+
5. Push the changes and raise a PR.
14+
6. Merge the PR onto `main` and then proceed to tag the appropriate commit using
1315
`git tag -s stackablectl-Y.Y.Z -m stackablectl-Y.Y.Z`.
14-
6. Building the artifacts and creating the release on GitHub is fully automated from this point
16+
7. Building the artifacts and creating the release on GitHub is fully automated from this point
1517
onward.

0 commit comments

Comments
 (0)