Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

soroban-cli: Update Release Docs #1201

Closed
wants to merge 1 commit into from
Closed

soroban-cli: Update Release Docs #1201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Comment on lines -3 to -5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The release process this repo should follow is still the linked rust release process, so I'm not sure this change is needed. The rust release process has instructions for how to create a release, which shouldn't be the git tag commands, but instead using the steps in the referenced markdown.

## 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<release_version_number> -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.
Loading