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

Add RELEASE.md #151

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Add RELEASE.md #151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# How to release wasm-shim

To release a version “vX.Y.Z” of the wasm-shim in GitHub and Quay.io, follow these steps:

1. Pick a `<git-ref>` (SHA-1) as source.

```shell
git checkout <git-ref>
```

2. Create a new "floating" commit with the release version removing the `-dev`
suffix ([example](https://github.com/Kuadrant/wasm-shim/commit/55d785e6f6f56b57184a95b5bf285f43226e8974)).

3. Create a new tag and named release `vX.Y.Z`. Push the tag to GitHub. This will trigger the image to be built in
Quay.io.

```shell
git tag -a vX.Y.Z -m "vX.Y.Z" -s
git push origin vX.Y.Z
```

4. Then at the GitHub repository, create a new release from the tag you just pushed, auto-generating the release notes.
This will trigger the workflow to build the wasm-shim binary to append to the
release ([example](https://github.com/Kuadrant/wasm-shim/releases/tag/v0.8.0)).

5. Now that the release has been created, create a PR to update to the next development (`-dev`)
version ([example](https://github.com/Kuadrant/wasm-shim/pull/150))
Loading