Skip to content

chore: update releases documentation #2353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
crozzy wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −3
Open

chore: update releases documentation #2353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions Documentation/contribution/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,18 @@
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.

## Process

### 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:

Expand All @@ -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.
Expand All @@ -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

Expand Down