Skip to content

Commit a9230dd

Browse files
committed
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 <joseph.crosland@gmail.com>
1 parent f6a412c commit a9230dd

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

Documentation/contribution/releases.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@
33
Clair releases are cut roughly every three months and actively maintained for
44
six.
55

6-
This means that bugfixes should be landed on `master` (if applicable) and then
6+
This means that bugfixes should be landed on `main` (if applicable) and then
77
marked for backporting to a minor version's release branch. The process for
88
doing this is not yet formalized.
99

1010
## Process
1111

1212
### Minor
1313

14+
Run the "prepare-release" workflow in GH to create PR to update the changelog.
15+
16+
Review and merge changelog update PR.
17+
1418
When cutting a new minor release, two things need to be done: creating a tag and
1519
creating a release branch. This can be done like so:
1620

@@ -19,10 +23,15 @@ git tag -as v4.x.0 HEAD
1923
git push upstream HEAD:release-4.x tag v4.x.0
2024
```
2125

22-
Then, a "release" needs to be created in the Github UI using the created tag.
26+
Check that a "release" has been created in the Github UI for the created tag.
2327

2428
### Patch
2529

30+
Run the "prepare-release" workflow in GH to create PR to update the changelog
31+
(the target branch should be the release branch).
32+
33+
Review and merge changelog update PR.
34+
2635
A patch release is just like a minor release with the caveat that minor version
2736
tags should *only* appear on release branches and a new branch does not need to
2837
be created.
@@ -33,7 +42,7 @@ git tag -as v4.x.1 HEAD
3342
git push upstream tag v4.x.1
3443
```
3544

36-
Then, a "release" needs to be created in the Github UI using the created tag.
45+
Check that a "release" has been created in the Github UI for the created tag.
3746

3847
### Creating Artifacts
3948

0 commit comments

Comments
 (0)