Skip to content

Commit

Permalink
update release docs with new release branch instructions
Browse files Browse the repository at this point in the history
Signed-off-by: ehearneredhat <ehearne@redhat.com>
  • Loading branch information
ehearneRedHat committed Aug 27, 2024
1 parent 6a113ed commit 2f829ac
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,34 @@

## Process

To release a version “v0.X.Y” of Authorino in GitHub and Quay.io, follow these steps:
To release a version “vX.Y.Z” of Authorino in GitHub and Quay.io, follow these steps:

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

```shell
git checkout <git-ref>
git checkout release-vX.Y.Z
```

2. Create a new tag and named release `v0.X.Y`. Push the tag to GitHub.
2. Change the `version` field in `build.yaml` to `vX.Y.Z` and save.

Check failure on line 13 in RELEASE.md

View workflow job for this annotation

GitHub Actions / trailing whitespace

[trailing whitespace] RELEASE.md#L13

2. Change the `version` field in `build.yaml` to `vX.Y.Z` and save.
Raw output
./RELEASE.md:13:2. Change the `version` field in `build.yaml` to `vX.Y.Z` and save. 

```yaml
# This is where the build configuration is stored.
build:
version: vX.Y.Z
```
3. Create a new tag and named release `vX.Y.Z`. Push the tag to GitHub.

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

Then at the GitHub repository, create a new release from the tag you just pushed. One could start autogenerating the
release notes and then write the change notes highlighting all the new features, bug fixes, enhancements, etc.
([example](https://github.com/Kuadrant/authorino/releases/tag/v0.9.0)).

3. Run the GHA ‘Build and push images’ for the `v0.X.Y` tag. This will cause a new image to be built and pushed to quay.io/kuadrant/authorino.
4. Run the GHA ‘Build and push images’ for the `vX.Y.Z` tag. This will cause a new image to be built and pushed to quay.io/kuadrant/authorino.

## Notes on Authorino’s automated builds

Expand Down

0 comments on commit 2f829ac

Please sign in to comment.