From b07c6b58ce61b0df9f976aa62327d37accd97a1f Mon Sep 17 00:00:00 2001 From: dd di cesare Date: Tue, 20 Feb 2024 16:23:08 +0100 Subject: [PATCH 1/3] [docs] Steps for releasing Authorino --- RELEASE.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..ff5967f3 --- /dev/null +++ b/RELEASE.md @@ -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 `` (SHA-1) as source. + +```shell +git checkout +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: – 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 host in the [Authorino Operator repository](https://github.com/Kuadrant/authorino-operator). From 9975ba1f33c37b806ed58a0e4a9165e231344ead Mon Sep 17 00:00:00 2001 From: dd di cesare Date: Tue, 20 Feb 2024 17:42:23 +0100 Subject: [PATCH 2/3] [format] Typos and format adjusted --- RELEASE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index ff5967f3..730dffef 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -28,6 +28,7 @@ release notes and then write the change notes highlighting all the new features, ## 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 . +`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 host in the [Authorino Operator repository](https://github.com/Kuadrant/authorino-operator). +into a single deployment file in the [Authorino Operator repository](https://github.com/Kuadrant/authorino-operator). From 805469b41beeb128e1aba39d10d6e17439b3b036 Mon Sep 17 00:00:00 2001 From: dd di cesare Date: Wed, 21 Feb 2024 09:36:25 +0100 Subject: [PATCH 3/3] [docs] Removing branch creation step * Not needed in Authorino --- RELEASE.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 730dffef..cd4aa156 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -8,9 +8,7 @@ To release a version “v0.X.Y” of Authorino in GitHub and Quay.io, follow the ```shell git checkout -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.