Skip to content

Commit 39afcb5

Browse files
Merge pull request #1798 from Nordix/kashif/document-golang-bump
📖 Document backporting rules for Go lang minor versions for images
2 parents 05d5177 + 7d675b0 commit 39afcb5

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

CONTRIBUTING.md

+29-4
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,35 @@ Types and functions not in public APIs are not considered part of the guarantee.
8484

8585
#### Backporting
8686

87-
We only accept backports of critical bugs, security issues, or bugs without
88-
easy workarounds, any
89-
backport MUST not be breaking for either API or behavioral changes.
90-
We generally do not accept PRs against older release branches.
87+
We generally do not accept PRs directly against release branches, while we might
88+
accept backports of fixes/changes already merged into the main branch.
89+
90+
We generally allow backports of the following kinds of changes to all maintained
91+
branches:
92+
93+
- Critical bug fixes, security issue fixes, or fixes for bugs without easy
94+
workarounds.
95+
- Dependency bumps for CVE (usually limited to CVE resolution; backports of
96+
non-CVE related version bumps are considered exceptions to be evaluated case by
97+
case)
98+
- Changes required to support new Kubernetes patch versions, when possible.
99+
- Changes to use the latest Go patch version to build controller images.
100+
- Changes to bump the Go minor version used to build controller images, if the
101+
Go minor version of a supported branch goes out of support (e.g. to pick up
102+
bug and CVE fixes). This has no impact on users importing Baremetal Operator
103+
as we won't modify the version in go.mod and the version in the Makefile
104+
does not affect them.
105+
- Improvements to existing docs
106+
- Improvements to the test framework
107+
108+
Like any other activity in the project, backporting a fix/change is a
109+
community-driven effort and requires that someone volunteers to own the task.
110+
In most cases, the cherry-pick bot can (and should) be used to automate
111+
opening a cherry-pick PR.
112+
113+
We generally do not accept backports to BMO release branches that are EOL (End
114+
of life). Check the [Version support](https://github.com/metal3-io/metal3-docs/blob/main/docs/user-guide/src/version_support.md#baremetal-operator)
115+
guide for reference.
91116

92117
## Branches
93118

0 commit comments

Comments
 (0)