Docs: add RELEASE.md and the release table in the README
Description
Documents how cluster-gateway is released now that it has release branches (#181–#186), so maintainers and KubeVela
contributors don't have to work it out from the workflows:
RELEASE.md(new):- the branches and which KubeVela lines use them (
release-1.10→ KubeVelamaster/ 1.12,release-1.9→
1.10 / 1.11); - backports with the labels or
/backport(#200), and Dependabot; - what each workflow publishes: BuildImage's
<branch>-<short sha>candidates andvX.Y.Zimages, whenlatest
moves, GoRelease's addon-manager image and charts, pre-release / Latest; - the release steps: candidate, test, tag, check, release notes, then update KubeVela's chart image and
go.modto
the same tag.
- the branches and which KubeVela lines use them (
- README: the image example uses
v1.9.2instead ofv1.1.12, mentions GHCR and the platforms, and a short
Releases table links toRELEASE.md.
The KubeVela column matches KubeVela's go.mod and vela-core chart on each branch today.
This PR carries the backport release-1.9 / backport release-1.10 labels, so its merge is also the backport
workflow's first real run: it should open one backport PR per branch, with CI starting on its own.
I have:
- Signed off the commits (DCO).
How has this been tested
Docs only. Every workflow behaviour described was checked against the workflow files on master, and the tags,
images and releases against what v1.9.2 / v1.10.0-alpha.1 published.
Summary by cubic
Documents cluster-gateway's release process now that it has release branches, so maintainers and contributors don't have to work it out from the workflow files.
- Adds
RELEASE.mdcovering the release branches and which KubeVela lines use them, backports via labels or/backport, what each workflow publishes (including that CI skips docs-only PRs), and the release steps. - Updates the README image example to
v1.9.2, mentions GHCR and supported platforms, and adds a short Releases table linking toRELEASE.md.