You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 3, 2025. It is now read-only.
docs: Update release documentation and add backport policies
- Revised instructions to reflect the release of version 1.0.0.
- Removed outdated milestone references; transitioning to a 6-week release cycle.
- Eliminated obsolete process instructions.
- Added guidelines for PATCH releases.
- Defined backport policy.
Copy file name to clipboardExpand all lines: RELEASING.md
+44-7Lines changed: 44 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Before starting, ensure the milestone is cleaned up. All issues that need to
12
12
get into the release should be closed and any issue that won't make the release
13
13
should be pushed to the next milestone.
14
14
15
-
These instructions use `v0.Y.0` as the example release. Please ensure to replace
15
+
These instructions use `v1.MINOR.PATCH` as the example release. Please ensure to replace
16
16
the version with the correct release being cut. It is also assumed that the upstream
17
17
operator-framework/catalogd repository is the `upstream` remote on your machine.
18
18
@@ -25,19 +25,56 @@ operator-framework/catalogd repository is the `upstream` remote on your machine:
25
25
git checkout main
26
26
git fetch upstream
27
27
git pull upstream main
28
-
git checkout -b release-v0.Y
29
-
git push upstream release-v0.Y
28
+
git checkout -b release-v1.Y
29
+
git push upstream release-v1.Y
30
30
```
31
31
32
32
2. Tag the release:
33
33
34
34
- ```sh
35
-
git tag -am "catalogd v0.Y.0"v0.Y.0
36
-
git push upstream v0.Y.0
35
+
git tag -am "catalogd v1.Y.0"v1.Y.0
36
+
git push upstream v1.Y.0
37
37
```
38
38
39
39
3. Check the status of the [release GitHub Action](https://github.com/operator-framework/catalogd/actions/workflows/release.yaml).
40
40
Once it is complete, the new release should appear on the [release page](https://github.com/operator-framework/catalogd/releases).
41
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.
42
+
### Procedure for Patch Releases
43
+
44
+
1. Create Pull requests against the release branch with cherry-picks of the commits that need to be included in the patch release.
45
+
46
+
- ```sh
47
+
git checkout -b release-v1.Y
48
+
git checkout -b my-cherry-pick-branch
49
+
git cherry-pick -x <commit-hash>
50
+
git push origin +my-cherry-pick-branch
51
+
```
52
+
53
+
2. Once all required PRs cherry-picks are merged and we are prepared to cut the patch release, create the PATCH release from the branch:
54
+
55
+
- ```sh
56
+
git checkout main
57
+
git fetch upstream
58
+
git checkout release-v1.Y
59
+
git tag -am "catalogd v1.Y.PATCH" v1.Y.PATCH
60
+
git push upstream v1.Y.PATCH
61
+
```
62
+
63
+
3. Check the status of the [release GitHub Action](https://github.com/operator-framework/catalogd/actions/workflows/release.yaml).
64
+
Once it is complete, the new release should appear on the [release page](https://github.com/operator-framework/catalogd/releases).
65
+
66
+
## Backporting Policy
67
+
68
+
Mainly critical issue fixes are backported to the most recent minor release.
69
+
Special backport requests can be discussed during the weekly Community meeting or via Slack channel;
70
+
this does not guarantee an exceptional backport will be created.
71
+
72
+
Occasionally non-critical issue fixes will be backported, either at an approver’s discretion or by request as noted above.
73
+
For information on contacting maintainers and attending meetings, check the community repository.
74
+
75
+
### Process
76
+
77
+
1. Create a PR with the fix cherry-picked against to the release branch.
78
+
2. Ask for a review from the maintainers.
79
+
3. Once approved, merge the PR and perform the Patch Release steps above.
0 commit comments