Skip to content

Commit

Permalink
Bump version & add release notes
Browse files Browse the repository at this point in the history
Signed-off-by: Brian H <brian.hardock@fermyon.com>
  • Loading branch information
fibonacci1729 committed Nov 8, 2024
1 parent 5e82d1a commit 413d905
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 6 deletions.
6 changes: 3 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ anyhow = "1"
async-trait = "0.1.74"
chrono = "0.4.38"
form_urlencoded = "1.0"
spin-executor = { version = "3.0.1", path = "crates/executor" }
spin-macro = { version = "3.0.1", path = "crates/macro" }
spin-executor = { version = "3.1.0", path = "crates/executor" }
spin-macro = { version = "3.1.0", path = "crates/macro" }
thiserror = "1.0.37"
wit-bindgen = { workspace = true }
routefinder = "0.5.3"
Expand Down Expand Up @@ -81,7 +81,7 @@ wasmtime-wasi-http = "18.0.1"
wit-component = "0.200.0"

[workspace.package]
version = "3.0.1"
version = "3.1.0"
authors = ["Fermyon Engineering <engineering@fermyon.com>"]
edition = "2021"
license = "Apache-2.0 WITH LLVM-exception"
Expand Down
27 changes: 27 additions & 0 deletions release-process.md
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.

0 comments on commit 413d905

Please sign in to comment.