Skip to content

Commit 2e1d7f9

Browse files
authored
Merge pull request #106 from kate-goldenring/document-release-process
Document plugin release process
2 parents 8680899 + 7f513a8 commit 2e1d7f9

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

release-process.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Cutting a new release of the Spin Kube plugin
2+
3+
To cut a new release of the Spin Kube plugin, you will need to do the following:
4+
5+
1. Confirm that [CI is green](https://github.com/spinframework/spin-trigger-sqs/actions) for the commit selected to be tagged and released.
6+
7+
2. Update [`go.mod`](https://github.com/spinframework/spin-plugin-kube/blob/main/go.mod#L13) to ensure that the Spin Operator module is at the desired/latest version. Create a pull request with these changes and merge once approved.
8+
9+
3. Change the version number in [spin-pluginify.toml](./spin-pluginify.toml). Create a pull request with these changes and merge once approved.
10+
11+
4. Checkout the commit with the version bump from above.
12+
13+
5. Create and push a new tag with a `v` and then the version number.
14+
15+
As an example, via the `git` CLI:
16+
17+
```console
18+
# Create a GPG-signed and annotated tag
19+
git tag -s -m "Spin Kube Plugin v0.4.0" v0.4.0
20+
21+
# Push the tag to the remote corresponding to spinframework/spin-kube-plugin (here 'origin')
22+
git push origin v0.4.0
23+
```
24+
25+
6. Pushing the tag upstream will trigger the [release action](https://github.com/spinframework/spin-plugin-kube/blob/main/.github/workflows/release.yml).
26+
- The release build will create the packaged versions of the plugin, the updated plugin manifest and a checksums file
27+
- These assets are uploaded to a new GitHub release for the pushed tag
28+
- Release notes are auto-generated but edit as needed especially around breaking changes or other notable items
29+
30+
7. Validate that CI created a PR in the [fermyon/spin-plugins](https://github.com/fermyon/spin-plugins) repository with the [updated manifest](https://github.com/fermyon/spin-plugins/tree/main/manifests/kube).
31+
32+
8. If applicable, create PR(s) or coordinate [documentation](https://github.com/spinframework/spinkube-docs) needs, e.g. for new features or updated functionality.

0 commit comments

Comments
 (0)