Skip to content

Commit b13e55c

Browse files
authored
Update release expectations (#554)
Signed-off-by: Alexander Greene <[email protected]>
1 parent 1f84177 commit b13e55c

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

RELEASE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# Release Process for OLM v1
22

33
## Choosing version increment
4-
When making releases for operator-controller, version increments should adhere strictly to Semantic Versioning. In short:
4+
5+
The `operator-controller` project is in its initial development phase and has yet to have a Major release, so users should assume that breaking changes may be seen in Minor releases as defined [here](https://semver.org/#spec-item-4).
6+
7+
In general, the `operator-controller`` will only support Minor releases until it has reached a degree of stability and adoption that the benefits of supporting Patch releases outweighs the costs of supporting this release workflow. If a member of the community strongly desires a patch release addressing a critical bug, they should submit an issue and it will be considered on a case-by-case basis.
8+
9+
In the future, the `operator-controller` will have a Major release in which we'll adopt the following Semantic Versioning guarantees:
510
* Major: API breaking change(s) are made.
611
* Minor: Backwards compatible features are added.
712
* Patch: Backwards compatible bug fix is made.
813

9-
When a major or minor release being made is associated with one or more milestones, please ensure that all related features have been merged into the `main` branch before continuing.
14+
When a Major or Minor release being made is associated with one or more milestones, please ensure that all related features have been merged into the `main` branch before continuing.
1015

1116
## Creating the release
1217
Note that throughout this guide, the `upstream` remote refers to the `operator-framework/operator-controller` repository.

0 commit comments

Comments
 (0)