Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add release process document #39

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Add release process document #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f63e0af
Add release process document
kate-goldenring Aug 21, 2024
901fb07
Update release-process.md
fibonacci1729 Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions release-process.md
View file
Open in desktop
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 spinkube/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.
Loading