From 57e2ddefa931e7c53ef49444c3a3ff0b1391d7a4 Mon Sep 17 00:00:00 2001 From: "Tyler.S" Date: Tue, 13 Feb 2024 20:00:32 -0800 Subject: [PATCH] Add release docs for CLI --- RELEASING.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 09a6a7b42..b2e3403ae 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,5 +1,18 @@ # Releasing -The process for how to release the crates in this repository are documented here: +To release Soroban CLI, follow this process **in order**: -https://github.com/stellar/actions/blob/main/README-rust-release.md +## Follow Rust Workflow +We will be running our main [Rust release workflow](https://github.com/stellar/actions/blob/main/README-rust-release.md). +Follow all the steps in order. + + +## Create a GitHub Release From a Tag +1. Create an annotated tag with `git tag -a v -m "Description for release"` +2. Push the tag to remote with `git push origin --tags` +3. Create a new [GitHub release](https://github.com/stellar/soroban-tools/releases/new) from the previously created tag. + * The release title MUST NOT start with a v, otherwise artifact uploads fail (see [workflow file](https://github.com/stellar/soroban-tools/blob/main/.github/workflows/publish.yml) and this [Slack thread](https://stellarfoundation.slack.com/archives/C04ECVCV162/p1694729751569919) for context) +4. Monitor GitHub actions until they succeed + +## Update homebrew-tap to Point to the Latest Released CLI +Update [Formula/soroban-cli.rb](https://github.com/stellar/homebrew-tap/blob/main/Formula/soroban-cli.rb) to point to the released CLI version.