From b0fad2202c58ec0cd3a0b6b7265708a7f4336b46 Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Thu, 9 Jan 2025 09:34:55 +0000 Subject: [PATCH] release: update the doc since it is no longer in a initial development version After the cut 1.0.0 we should follow semver --- RELEASE.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 093f1fd2e..9b221cbed 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -2,20 +2,18 @@ ## Choosing version increment -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). +The `operator-controller` following Semantic Versioning guarantees: -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. +Note that throughout this guide, the `upstream` remote refers to the `operator-framework/operator-controller` repository. The release process differs slightly based on whether a patch or major/minor release is being made. ### Patch Release