Skip to content

Commit ae6c59d

Browse files
authored
Merge pull request #7823 from fabriziopandini/clarify-backport-policy
🌱 Small improvement to the backport policy
2 parents 6c5ee02 + 60f2032 commit ae6c59d

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,16 +82,26 @@ The test module, clusterctl, and experiments do not provide any backward compati
8282

8383
#### Backporting a patch
8484

85-
We only accept backports of critical bugs, security issues, or bugs without easy workarounds, any
86-
backport MUST not be breaking for either API or behavioral changes. In order to improve user/developer experience
87-
maintainers can choose to backport:
88-
- Doc improvements
85+
We generally do not accept PRs directly against release branches, while we might accept backports of fixes/changes already
86+
merged into the main branch.
87+
88+
Any backport MUST not be breaking for either API or behavioral changes.
89+
90+
We generally allow backports of following changes to all supported branches:
91+
- Critical bugs fixes, security issue fixes, or fixes for bugs without easy workarounds.
92+
- Dependency bumps for CVE (usually limited to CVE resolution; backports of non-CVE related version bumps are considered exceptions to be evaluated case by case)
93+
- Cert-manager version bumps (to avoid having releases with cert-manager versions that are out of support, when possible)
94+
- Changes required to support new Kubernetes versions, when possible. See [supported Kubernetes versions](https://cluster-api.sigs.k8s.io/reference/versions.html#supported-kubernetes-versions) for more details.
95+
96+
We generally allow backports of following changes only to the latest supported branch:
97+
- Improvements to existing docs (the latest supported branch hosts the current version of the book)
8998
- Improvements to CI signal
90-
- Improvements to the test framework (enabling improvements to provider's test signal)
91-
- Cert-manager bump (to avoid having branch using cert-manager versions out of support, when possible)
92-
- Changes required to support new Kubernetes versions, when possible.
99+
- Improvements to the test framework
100+
101+
Like any other activity in the project, backporting a fix/change is a community-driven effort and requires that someone volunteers to own the task.
102+
In most cases, the cherry-pick bot can (and should) be used to automate opening a cherry-pick PR.
93103

94-
We generally do not accept PRs against older release branches.
104+
We generally do not accept backports to Cluster API release branches that are [out of support](https://github.com/kubernetes-sigs/cluster-api/blob/main/CONTRIBUTING.md#support-and-guarantees).
95105

96106
### APIs
97107

0 commit comments

Comments
 (0)