Skip to content

Commit

Permalink
Merge pull request #849 from fibonacci1729/release-doc
Browse files Browse the repository at this point in the history
Add back release doc
  • Loading branch information
fibonacci1729 authored Oct 21, 2022
2 parents 695bcce + db05f66 commit 14ced57
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/content/release-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
title = "Creating a new Spin release"
template = "spin_main"
date = "2022-03-14T00:22:56Z"
[extra]
url = "https://github.com/fermyon/spin/blob/main/docs/content/release-process.md"
---

To cut a release of Spin, you will need to do the following:

1. Create a pull request that changes the version number for your new version
(e.g. `0.6.0` becomes `0.6.1`)
- Bump the version in Spin's `Cargo.toml`
- Bump the version in the Rust SDK as well (`sdk/rust/Cargo.toml`)
- Check the docs for hard-coded version strings
1. Merge the PR created in #1 (Such PRs are still required to get approvals, so
make sure you get signoff on the PR)
1. Before proceeding, verify that the merge commit on `main` intended to be
tagged is green, i.e. CI is successful
1. Create a new tag with a `v` and then the version number (`v0.6.1`)
1. The Go SDK tag `sdk/go/v0.6.1` will be created in the [release action].
1. When the [release action] completes, binary artifacts and checksums will be
automatically uploaded to the GitHub release.
1. A Pull Request will also be created by `fermybot` containing changes to the
templates per the updated SDK version. Once CI completes, approve this PR and
merge via a merge commit. This will trigger the `push-templates-tag` job in
the [release action], pushing the `spin/templates/v0.6` tag. (Note
that this tag may be force-pushed for all patch releases of a given minor release.)
1. Go to the GitHub [tags page](https://github.com/fermyon/spin/releases),
edit a release, add the release notes.

At this point, you can verify in the GitHub UI that the release was successful.

[release action]: https://github.com/fermyon/spin/actions/workflows/release.yml

0 comments on commit 14ced57

Please sign in to comment.