Skip to content

Commit 06f0f9f

Browse files
authored
Add RELEASING.md (operator-framework#176)
Add release guide Signed-off-by: Catherine Chan-Tse <[email protected]>
1 parent 7272fd4 commit 06f0f9f

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

RELEASING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Release Guide
2+
3+
These steps describe how to cut a release of the catalogd repo.
4+
5+
## Table of Contents:
6+
7+
- [Major and minor releases](#major-and-minor-releases)
8+
9+
## Major and Minor Releases
10+
11+
Before starting, ensure the milestone is cleaned up. All issues that need to
12+
get into the release should be closed and any issue that won't make the release
13+
should be pushed to the next milestone.
14+
15+
These instructions use `v0.Y.0` as the example release. Please ensure to replace
16+
the version with the correct release being cut. It is also assumed that the upstream
17+
operator-framework/catalogd repository is the `upstream` remote on your machine.
18+
19+
### Procedure
20+
21+
1. Create a release branch by running the following, assuming the upstream
22+
operator-framework/catalogd repository is the `upstream` remote on your machine:
23+
24+
- ```sh
25+
git checkout main
26+
git fetch upstream
27+
git pull upstream main
28+
git checkout -b release-v0.Y
29+
git push upstream release-v0.Y
30+
```
31+
32+
2. Tag the release:
33+
34+
- ```sh
35+
git tag -am "catalogd v0.Y.0" v0.Y.0
36+
git push upstream v0.Y.0
37+
```
38+
39+
3. Check the status of the [release GitHub Action](https://github.com/operator-framework/catalogd/actions/workflows/release.yaml).
40+
Once it is complete, the new release should appear on the [release page](https://github.com/operator-framework/catalogd/releases).
41+
42+
4. Clean up the GitHub milestone:
43+
- In the [GitHub milestone](https://github.com/operator-framework/catalogd/milestones), bump any open issues to the following release and then close out the milestone.

0 commit comments

Comments
 (0)