Skip to content

Commit 8352719

Browse files
release: update the doc since it is no longer in a initial development version (#1558)
After the cut 1.0.0 we should follow semver
1 parent 6cc4e81 commit 8352719

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

RELEASE.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,18 @@
22

33
## Choosing version increment
44

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).
5+
The `operator-controller` following Semantic Versioning guarantees:
66

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:
107
* Major: API breaking change(s) are made.
118
* Minor: Backwards compatible features are added.
129
* Patch: Backwards compatible bug fix is made.
1310

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.
11+
When a Major or Minor release being made is associated with one or more milestones,
12+
please ensure that all related features have been merged into the `main` branch before continuing.
1513

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

16+
Note that throughout this guide, the `upstream` remote refers to the `operator-framework/operator-controller` repository.
1917
The release process differs slightly based on whether a patch or major/minor release is being made.
2018

2119
### Patch Release

0 commit comments

Comments
 (0)