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
Copy file name to clipboardExpand all lines: RELEASE.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,17 @@ The version is defined in the `Makefile`:
9
9
VERSION ?= X.Y.Z
10
10
```
11
11
12
-
**Important:** The `main` branch always has `VERSION ?= 0.0.0` as a placeholder. The actual version is only set on release branches (e.g., `release-v0.1`). This follows the same pattern as [kuadrant-operator](https://github.com/Kuadrant/kuadrant-operator). When building release images, the version is read from the release branch where the automated workflow updated it.
12
+
**Important:** The `main` branch always has `VERSION ?= 0.0.0` as a placeholder. The actual version is only set on release branches (e.g., `release-0.1`). This follows the same pattern as [kuadrant-operator](https://github.com/Kuadrant/kuadrant-operator). When building release images, the version is read from the release branch where the automated workflow updated it.
13
13
14
14
## Automated Workflow (Recommended)
15
15
16
16
_**IMPORTANT:**_
17
-
For RC2+ or patch releases, set `gitRef` to the existing release branch (e.g., `release-v0.1`), not `main`.
17
+
For RC2+ or patch releases, set `gitRef` to the existing release branch (e.g., `release-0.1`), not `main`.
18
18
The workflow picks up all history from the specified gitRef - cherry-pick any required fixes to the release branch before triggering the workflow.
19
19
20
20
### Notes
21
21
* The automated workflow is best suited for RC1 of a new point release from `main`.
22
-
* For patch releases (e.g., 0.1.1): Cherry-pick only the bug fix to the release branch, then run the workflow with `gitRef: release-v0.1`.
22
+
* For patch releases (e.g., 0.1.1): Cherry-pick only the bug fix to the release branch, then run the workflow with `gitRef: release-0.1`.
23
23
* It's not possible to cherry-pick commits within the workflow - it will include all history from the gitRef.
24
24
25
25
### Steps
@@ -48,14 +48,14 @@ To release a patch (e.g., `0.1.1` after `0.1.0` with a bug fix from `main`):
48
48
49
49
1.**Cherry-pick the fix to the release branch**:
50
50
```bash
51
-
git checkout release-v0.1
52
-
git pull origin release-v0.1
51
+
git checkout release-0.1
52
+
git pull origin release-0.1
53
53
git cherry-pick <commit-sha># Only the bug fix, not new features
54
-
git push origin release-v0.1
54
+
git push origin release-0.1
55
55
```
56
56
57
57
2.**Run the Automated Release workflow**:
58
-
-**gitRef**: `release-v0.1` (the release branch, NOT main)
58
+
-**gitRef**: `release-0.1` (the release branch, NOT main)
59
59
-**version**: `0.1.1`
60
60
61
61
3.**Review and merge the PR**, then the release will be created automatically.
0 commit comments