diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..cd4aa156 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,32 @@ +# 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 `` (SHA-1) as source. + +```shell +git checkout +``` + +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:` – the `quay.io/kuadrant/authorino:latest` tag is also moved to match the latest +``. +* Authorino repo owns the manifests required by the operand: AuthConfig CRD + role definitions. A copy of these is merged +into a single deployment file in the [Authorino Operator repository](https://github.com/Kuadrant/authorino-operator).