Release doc update #1169
Release doc update #1169
Conversation
- fix naming issue - refine process steps Signed-off-by: Jim Fitzpatrick <[email protected]>
RELEASE.md
Outdated
| * [Authorino Operator](https://github.com/Kuadrant/authorino-operator/blob/main/RELEASE.md). | ||
| * [Limitador Operator](https://github.com/Kuadrant/limitador-operator/blob/main/RELEASE.md). | ||
| * [DNS Operator](https://github.com/Kuadrant/dns-operator/blob/main/docs/RELEASE.md). | ||
| * [WASM Shim](https://github.com/Kuadrant/wasm-shim/). | ||
| * [Console Plugin](https://github.com/Kuadrant/kuadrant-console-plugin). | ||
|
|
||
| 2. Run the GHA [Release operator](https://github.com/Kuadrant/kuadrant-operator/actions/workflows/release.yaml); make |
There was a problem hiding this comment.
It seems it will be up to my following PR to address the automated workflow and final docs changes
There was a problem hiding this comment.
This may be no longer valid. Was targeting the branch for the merge. Can you recheck.
RELEASE.md
Outdated
| @@ -1,31 +1,72 @@ | |||
| # How to release Kuadrant Operator | |||
|
|
|||
| ## Process | |||
| ## Kuadrant Operator Release | |||
There was a problem hiding this comment.
Probably merge this PR after #1150
There was a problem hiding this comment.
Sorry worry branch target for the merge. Trying the gh cli lately to create PRs and never though about which branch it was being opened against.
| 1. Create the `release-vX.Y` branch, if the branch does not already exist. | ||
| 2. Push the `release-vX.Y` to the remote (kuadrant/kuadrant-operator) | ||
| 3. Create the `release-vX.Y.Z-rc(n)` branch with `release-vX.Y` as the base. | ||
| 4. Cherry-pick commits to the `kudrant-vX.Y.Z-rc(n)` from the relevant sources, i.e. `main`. |
There was a problem hiding this comment.
The commits of changes that would be introduced in the RC that is being created.
There was a problem hiding this comment.
I do not think we should mix in the same PR changes from fixes/features and changes for releasing. Just my opinion. If you still want to do that, be my guest.
| 2. PR verification checks will run. | ||
| 3. Get manual review of PR with focus on changes in these areas: | ||
| * `./bundle.Dockerfile` | ||
| * `./bundle` | ||
| * `./config` | ||
| * `./charts/` | ||
| 4. Merge PR | ||
| 5. Run the Release Workflow on the `kuadrant-vX.Y`. This does the following: | ||
| 5. Run the Release Workflow on the `release-vX.Y`. This does the following: |
There was a problem hiding this comment.
Do we expect this to be triggered automaticaly in the future? It is ok for now to be manually triggered.
There was a problem hiding this comment.
Yup, I'll make sure to update the docs once the automated workflow PR is ready
| # FILE: ./release.yaml | ||
| kuadrant: | ||
| release: "1.0.1" | ||
| olm: | ||
| channels: | ||
| - "alpha" | ||
| default_channel: "alpha" | ||
| dependencies: | ||
| Authorino: "0.16.0" | ||
| Console_plugin: "0.0.14" | ||
| DNS: "0.12.0" | ||
| Limitador: "0.12.1" | ||
| Wasm_shim: "0.8.1" |
There was a problem hiding this comment.
| # FILE: ./release.yaml | |
| kuadrant: | |
| release: "1.0.1" | |
| olm: | |
| channels: | |
| - "alpha" | |
| default_channel: "alpha" | |
| dependencies: | |
| Authorino: "0.16.0" | |
| Console_plugin: "0.0.14" | |
| DNS: "0.12.0" | |
| Limitador: "0.12.1" | |
| Wasm_shim: "0.8.1" | |
| # FILE: ./release.yaml | |
| version: "1.0.1" | |
| dependencies: | |
| authorino-operator: "0.16.0" | |
| console-plugin: "0.0.14" | |
| dns-operator: "0.12.0" | |
| limitador-operator: "0.12.1" | |
| wasm_shim: "0.8.1" | |
| olm: | |
| channels: | |
| - "alpha" | |
| default_channel: "alpha" |
Firstly fix the branch naming. It was
kuadrant-vX.Y, and this should have beingrelease-vX.Y.The main focus of this change is to get agreement on the steps required for bringing changes into the release branch. An initial conversation start here: https://github.com/Kuadrant/kuadrant-operator/pull/1150/files/44d9def260bc817dfcfa16c93f0c68c344349d51#r1946446898