From 2f4b47e35e95d8ab9ebb5e3bbc2099024353a534 Mon Sep 17 00:00:00 2001 From: crozzy Date: Wed, 10 Dec 2025 10:55:12 -0800 Subject: [PATCH] chore: update releases documentation The release documentation was out-of-date for how the current release process works, namely, users should prepare a release and don't have to manually create Releases in the GH UI. Signed-off-by: crozzy --- Documentation/contribution/releases.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/Documentation/contribution/releases.md b/Documentation/contribution/releases.md index a62fabd4af..b11e987eeb 100644 --- a/Documentation/contribution/releases.md +++ b/Documentation/contribution/releases.md @@ -3,7 +3,7 @@ Clair releases are cut roughly every three months and actively maintained for six. -This means that bugfixes should be landed on `master` (if applicable) and then +This means that bugfixes should be landed on `main` (if applicable) and then marked for backporting to a minor version's release branch. The process for doing this is not yet formalized. @@ -11,6 +11,10 @@ doing this is not yet formalized. ### Minor +Run the "prepare-release" workflow in GH to create PR to update the changelog. + +Review and merge changelog update PR. + When cutting a new minor release, two things need to be done: creating a tag and creating a release branch. This can be done like so: @@ -19,10 +23,15 @@ git tag -as v4.x.0 HEAD git push upstream HEAD:release-4.x tag v4.x.0 ``` -Then, a "release" needs to be created in the Github UI using the created tag. +Check that a "release" has been created in the Github UI for the created tag. ### Patch +Run the "prepare-release" workflow in GH to create PR to update the changelog +(the target branch should be the release branch). + +Review and merge changelog update PR. + A patch release is just like a minor release with the caveat that minor version tags should *only* appear on release branches and a new branch does not need to be created. @@ -33,7 +42,7 @@ git tag -as v4.x.1 HEAD git push upstream tag v4.x.1 ``` -Then, a "release" needs to be created in the Github UI using the created tag. +Check that a "release" has been created in the Github UI for the created tag. ### Creating Artifacts