Skip to content

Commit 0f4a5da

Browse files
committed
chore: Add release instructions
1 parent aafc943 commit 0f4a5da

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

rust/stackablectl/RELEASE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Release Process
2+
3+
The release of `stackablectl` is currently mostly done manually. This means the following steps need
4+
to be done:
5+
6+
1. Ensure your local `main` branch is up-to-date and then proceed to checkout a new branch using
7+
`git checkout -b chore/release-stackablectl-X.Y.Z`.
8+
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
10+
`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+
`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
15+
onward.

0 commit comments

Comments
 (0)