Skip to content

Commit

Permalink
[docs] Steps for releasing Authorino
Browse files Browse the repository at this point in the history
  • Loading branch information
didierofrivia committed Feb 20, 2024
1 parent 744220a commit b07c6b5
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# How to release Authorino

## Process

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

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

```shell
git checkout <git-ref>
git checkout -b release-v0.X.Y
```
This will create a new branch `release-v0.X.Y` from the commit you want to release.

2. Create a new tag and named release `v0.X.Y`. Push the tag to GitHub.

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

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.

## Notes on Authorino’s automated builds

* PRs merged to the main branch of Authorino cause a new image to be built (GH Action) and pushed automatically to
quay.io/kuadrant/authorino:<git-ref> – the quay.io/kuadrant/authorino:latest tag is also moved to match the latest <git-ref>.
* Authorino repo owns the manifests required by the operand: AuthConfig CRD + role definitions. A copy of these is merged
into a single deployment file host in the [Authorino Operator repository](https://github.com/Kuadrant/authorino-operator).

0 comments on commit b07c6b5

Please sign in to comment.