-
Notifications
You must be signed in to change notification settings - Fork 10
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: Kate Goldenring <[email protected]>
- Loading branch information
1 parent
8d3e0c2
commit f63e0af
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
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,32 @@ | ||
# Cutting a new release of the Spin MQTT trigger plugin | ||
|
||
To cut a new release of the MQTT trigger plugin, you will need to do the following: | ||
|
||
1. Confirm that [CI is green](https://github.com/spinkube/spin-trigger-mqtt/actions) for the commit selected to be tagged and released. | ||
|
||
2. Change the version number in [Cargo.toml](./Cargo.toml) and [spin-pluginify.toml](./spin-pluginify.toml) and run `cargo build --release`. | ||
|
||
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 MQTT Trigger v0.2.0" v0.2.0 | ||
# Push the tag to the remote corresponding to fermyon/spin-trigger-mqtt (here 'origin') | ||
git push origin v0.2.0 | ||
``` | ||
|
||
6. Pushing the tag upstream will trigger the [release action](https://github.com/spinkube/spin-trigger-mqtt/actions/workflows/release.yml). | ||
- The release build will create the packaged versions of the plugin, the updated plugin manifest and a checksums file | ||
- These assets are uploaded to a new GitHub release for the pushed tag | ||
- Release notes are auto-generated but edit as needed especially around breaking changes or other notable items | ||
|
||
7. Create 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/mqtt-trigger). | ||
|
||
8. If applicable, create PR(s) or coordinate [documentation](https://github.com/fermyon/developer) needs, e.g. for new features or updated functionality. |