-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Brian H <brian.hardock@fermyon.com>
- Loading branch information
1 parent
5e82d1a
commit 413d905
Showing
3 changed files
with
33 additions
and
6 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Cutting a new release of the Spin Rust SDK | ||
|
||
To cut a new release, you will need to do the following: | ||
|
||
1. Confirm that [CI is green](https://github.com/fermyon/spin-rust-sdk/actions) for the commit selected to be tagged and released. | ||
|
||
2. Change the workspace version number in [Cargo.toml](./Cargo.toml) and the versions for any dependencies that are part of this workspace (e.g. `spin-macro`). | ||
|
||
3. Create a pull request with these changes and merge once approved. | ||
|
||
4. Checkout the commit with the version bump from above. | ||
|
||
5. Create and push a new tag with a `v` and then the version number. | ||
|
||
As an example, via the `git` CLI: | ||
|
||
``` | ||
# Create a GPG-signed and annotated tag | ||
git tag -s -m "Spin Rust SDK v3.1.0" v3.1.0 | ||
# Push the tag to the remote corresponding to fermyon/spin-rust-sdk (here 'origin') | ||
git push origin v3.1.0 | ||
``` | ||
6. Pushing the tag upstream will trigger the [release action](https://github.com/fermyon/spin-rust-sdk/actions/workflows/release.yml) which publishes the crates in this workspace to `crates.io` | ||
7. If applicable, create PR(s) or coordinate [documentation](https://github.com/fermyon/developer) needs, e.g. for new features or updated functionality. |