Skip to content

Commit

Permalink
Update release expectations (#554)
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Greene <greene.al1991@gmail.com>
  • Loading branch information
awgreene committed Nov 28, 2023
1 parent 1f84177 commit b13e55c
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# Release Process for OLM v1

## Choosing version increment
When making releases for operator-controller, version increments should adhere strictly to Semantic Versioning. In short:

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).

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.

In the future, the `operator-controller` will have a Major release in which we'll adopt the following Semantic Versioning guarantees:
* Major: API breaking change(s) are made.
* Minor: Backwards compatible features are added.
* Patch: Backwards compatible bug fix is made.

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.
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.

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

0 comments on commit b13e55c

Please sign in to comment.