Skip to content

Commit

Permalink
Merge pull request #1942 from vdice/ci/check-prerelease
Browse files Browse the repository at this point in the history 
ci/docs(releasing): updates for release candidates
  • Loading branch information
@vdice
vdice authored Oct 26, 2023
2 parents fd3a9a7 + 328fc76 commit e29eabe
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 24 deletions.
14 changes: 13 additions & 1 deletion .github/workflows/release.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ jobs:
id-token: write
# needed to upload artifacts to a GH release
contents: write
outputs:
prerelease: ${{ steps.release-version.outputs.prerelease }}
strategy:
matrix:
config:
Expand Down Expand Up @@ -114,6 +116,14 @@ jobs:
echo 'linker = "aarch64-linux-gnu-gcc"' >> ${HOME}/.cargo/config.toml
echo 'rustflags = ["-Ctarget-feature=+fp16"]' >> ${HOME}/.cargo/config.toml
- name: Check if pre-release
id: release-version
shell: bash
run: |
[[ "${{ env.RELEASE_VERSION }}" =~ ^v[0-9]+.[0-9]+.[0-9]+$ ]] && \
echo "prerelease=false" >> "$GITHUB_OUTPUT" || \
echo "prerelease=true" >> "$GITHUB_OUTPUT"
- name: build release
shell: bash
run: cargo build --release ${{ matrix.config.extraArgs }}
Expand Down Expand Up @@ -163,6 +173,7 @@ jobs:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: _dist/spin-${{ env.RELEASE_VERSION }}-${{ env.RUNNER_OS }}-${{ matrix.config.arch }}.tar.gz
tag: ${{ github.ref }}
prerelease: ${{ steps.release-version.outputs.prerelease == 'true' }}

- name: upload binary as GitHub artifact
if: runner.os == 'Windows'
Expand All @@ -178,6 +189,7 @@ jobs:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: _dist/spin-${{ env.RELEASE_VERSION }}-${{ env.RUNNER_OS }}-${{ matrix.config.arch }}.zip
tag: ${{ github.ref }}
prerelease: ${{ steps.release-version.outputs.prerelease == 'true' }}

- name: Configure AWS Credentials
if: runner.os == 'linux' && matrix.config.arch == 'amd64' && github.repository_owner == 'fermyon'
Expand Down Expand Up @@ -227,7 +239,7 @@ jobs:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: checksums-${{ env.RELEASE_VERSION }}.txt
tag: ${{ github.ref }}

prerelease: ${{ needs.build-and-sign.outputs.prerelease == 'true' }}

update-canary:
name: update canary release
Expand Down
84 changes: 61 additions & 23 deletions docs/content/release-process.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,38 +10,38 @@ url = "https://github.com/fermyon/spin/blob/main/docs/content/release-process.md

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

1. Create a release branch, e.g. `v1.1`. With our branch protection rules this is easiest from the Github UI with the [New Branch button here](https://github.com/fermyon/spin/branches).
1. Create a release branch, e.g. `v2.0`. With our branch protection rules this is easiest from the Github UI with the [New Branch button here](https://github.com/fermyon/spin/branches).

1. Switch to the release branch locally and update versions (e.g. `1.1.0-pre0` could `1.1.0`).
1. Switch to the release branch locally and update versions (e.g. `2.0.0-pre0` could be `2.0.0`).
- Bump the version in Spin's `Cargo.toml`
- Run `make build` so that `Cargo.lock` and other associated files are updated

PR these changes to the release branch ensuring that pull request has a base corresponding to the release branch (e.g. `v1.1`).
PR these changes to the release branch ensuring that pull request has a base corresponding to the release branch (e.g. `v2.0`).

1. Create a new tag with a `v` and then the version number, e.g. `v1.1.0`. Then, push the tag to the `fermyon/spin` origin repo.
1. Create a new tag with a `v` and then the version number, e.g. `v2.0.0`. Then, push the tag to the `fermyon/spin` origin repo.

As an example, via the `git` CLI:

```
# Switch to the release branch
git checkout v1.1
git checkout v2.0
git pull
# Create a GPG-signed and annotated tag
git tag -s -m "Spin v1.1.0" v1.1.0
git tag -s -m "Spin v2.0.0" v2.0.0
# Push the tag to the remote corresponding to fermyon/spin (here 'origin')
git push origin v1.1.0
git push origin v2.0.0
```

**NOTE**
> The Go SDK tag associated with this release (e.g. `sdk/go/v1.1.0`) will be
> The Go SDK tag associated with this release (e.g. `sdk/go/v2.0.0`) will be
> created in the [release action] that has been triggered by the tag push.
>
> When the [release action] completes, binary artifacts and checksums will be
> automatically uploaded to the GitHub release.
1. Switch back to `main` and update the `Cargo.toml` and `templates/Makefile` versions again, this time to e.g. `1.2.0-pre0` if `1.2.0` is the next anticipated release.
1. Switch back to `main` and update the `Cargo.toml` and `templates/Makefile` versions again, this time to e.g. `2.1.0-pre0` if `2.1.0` is the next anticipated release.
- Run `make build` so that `Cargo.lock` and other associated files are updated
- PR this to `main`
- See [sips/011-component-versioning.md](sips/011-component-versioning.md)
Expand All @@ -59,30 +59,68 @@ To cut a patch release of Spin, you will need to do the following:
$ ./.github/gh-backport.sh <pull-request> <branch-name>
```

1. Switch to the release branch locally and update versions (e.g. `1.1.0-pre0` could `1.1.1`).
1. Switch to the release branch locally and update versions (e.g. `2.0.0` could be `2.0.1`).
- Bump the version in Spin's `Cargo.toml`
- Run `make build` so that `Cargo.lock` and other associated files are updated

PR these changes to the release branch ensuring that pull request has a base corresponding to the release branch (e.g. `v1.1`).
PR these changes to the release branch ensuring that pull request has a base corresponding to the release branch (e.g. `v2.0`).

1. Create a new tag with a `v` and then the version number, e.g. `v1.1.1`. Then, push the tag to the `fermyon/spin` origin repo.
1. Create a new tag with a `v` and then the version number, e.g. `v2.0.1`. Then, push the tag to the `fermyon/spin` origin repo.

As an example, via the `git` CLI:

```
# Switch to the release branch
git checkout v1.1
git checkout v2.0
git pull
# Create a GPG-signed and annotated tag
git tag -s -m "Spin v1.1.1" v1.1.1
git tag -s -m "Spin v2.0.1" v2.0.1
# Push the tag to the remote corresponding to fermyon/spin (here 'origin')
git push origin v1.1.1
git push origin v2.0.1
```

**NOTE**
> The Go SDK tag associated with this release (e.g. `sdk/go/v1.1.0`) will be
> The Go SDK tag associated with this release (e.g. `sdk/go/v2.0.0`) will be
> created in the [release action] that has been triggered by the tag push.
>
> When the [release action] completes, binary artifacts and checksums will be
> automatically uploaded to the GitHub release.
Follow the [wrapping up](#wrapping-up) section to finish off the release process.

## Release Candidate

To create a release candidate for a major/minor version of Spin, you will need to do the following:

1. Create the release branch if not already created. With our branch protection rules this is easiest from the Github UI with the [New Branch button here](https://github.com/fermyon/spin/branches).
Otherwise, switch to the branch locally.

1. Update the Spin version with `-rc.N` where `N` is the release candidate number (e.g. `2.0.0-pre0` could be `2.0.0-rc.1`).
- Bump the version in Spin's `Cargo.toml`
- Run `make build` so that `Cargo.lock` and other associated files are updated

PR these changes to the release branch ensuring that pull request has a base corresponding to the release branch (e.g. `v2.0`).

1. Create a new tag with a `v` and then the version used above, e.g. `v2.0.0-rc.1`. Then, push the tag to the `fermyon/spin` origin repo.

As an example, via the `git` CLI:

```
# Switch to the release branch
git checkout v2.0
git pull
# Create a GPG-signed and annotated tag
git tag -s -m "Spin v2.0.0-rc.1" v2.0.0-rc.1
# Push the tag to the remote corresponding to fermyon/spin (here 'origin')
git push origin v2.0.0-rc.1
```

**NOTE**
> The Go SDK tag associated with this release (e.g. `sdk/go/v2.0.0-rc.1`) will be
> created in the [release action] that has been triggered by the tag push.
>
> When the [release action] completes, binary artifacts and checksums will be
Expand All @@ -92,21 +130,21 @@ $ ./.github/gh-backport.sh <pull-request> <branch-name>

## Wrapping up

1. A Pull Request will be created by `fermybot` containing changes to the templates per the updated SDK version. If this is a pre-release for a major/minor version, be sure to change the base of the PR from `main` to the release branch, e.g. `v1.1`. Once CI completes, approve this PR and merge via a merge commit (rather than squash or rebase).
1. A Pull Request will 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 (rather than squash or rebase).

>This will trigger the `push-templates-tag` job in the [release action], pushing the `spin/templates/v0.9` tag. (Note that this tag may be force-pushed for all patch releases of a given minor release.)
>This will trigger the `push-templates-tag` job in the [release action], pushing the `spin/templates/v2.0` 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 the release and add the release notes.
edit the release and add the release notes. (This step is optional if a release candidate.)

1. Be sure to include instructions for
[verifying the signed Spin binary](./sips/012-signing-spin-releases.md). The
`--certificate-identity` value should match this release, e.g.
`https://github.com/fermyon/spin/.github/workflows/release.yml@refs/tags/v1.1.0`.
`https://github.com/fermyon/spin/.github/workflows/release.yml@refs/tags/v2.0.0`.

1. Create a Pull Request into Fermyon's Hombrew tap repository updating the [Spin
formula](https://github.com/fermyon/homebrew-tap/blob/main/Formula/spin.rb). In the formula,
update the version, point to the latest release artifacts, and set their correct sha256 digests.
1. Unless this is a release candidate, create a Pull Request into Fermyon's Hombrew tap
repository updating the [Spin formula](https://github.com/fermyon/homebrew-tap/blob/main/Formula/spin.rb).
In the formula, update the version, point to the latest release artifacts, and set their correct sha256 digests.

The release is now complete!

Expand Down

0 comments on commit e29eabe

Please sign in to comment.