Skip to content

Commit ad3f395

Browse files
Eric Stroczynskitimflannagan
authored andcommitted
chore(docs): emphasize release versioning requirements (openshift#162)
Signed-off-by: Eric Stroczynski <[email protected]> Upstream-repository: api Upstream-commit: 242f6fd9ceef190bf9250e5ac431057a7f3f32b9
1 parent 509e672 commit ad3f395

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

staging/api/RELEASE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ post to the [operator-framework group][of-ggroup].
88
## Tags
99

1010
As per semver, all releases containing new features must map to a major or minor version increase.
11-
Patch releases must only contain fixes to features released in a prior release.
11+
12+
**Patch releases must only contain bug fixes. Releases containing features must be major or minor releases.**
1213

1314
## Process
1415

@@ -31,6 +32,8 @@ Then create release notes while still on the `master` branch:
3132
while read -r line; do echo $line | awk '{f = $1; $1 = ""; print "-"$0; }'; done <<< $(git log $PREVIOUS_RELEASE_TAG..$RELEASE_TAG --format=oneline --no-merges)
3233
```
3334

35+
**You cannot cut a patch release if any of these release notes start with `feat:` or `feature:`.**
36+
3437
Copy them into the Github release [description form][release-desc-page],
3538
select `vX.Y.Z` in the `Tag version` form, and click `Publish release`.
3639

0 commit comments

Comments
 (0)