From d3ad840d8c0b1db3d499ced3ebeef694c57f6b15 Mon Sep 17 00:00:00 2001 From: Michael Zalimeni Date: Tue, 4 Jun 2024 12:46:20 -0400 Subject: [PATCH] [NET-8953] docs: add backport policy section to CONTRIBUTING (#21252) docs: add backport policy section to CONTRIBUTING Add detail about Consul's backport policy w.r.t. LTS/CE. Also update label docs and remove defunct redirect .md files. --- .github/CONTRIBUTING.md | 19 +++++++++++++------ contributing/INTERNALS.md | 1 - contributing/README.md | 1 - 3 files changed, 13 insertions(+), 8 deletions(-) delete mode 100644 contributing/INTERNALS.md delete mode 100644 contributing/README.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c6c09d402a..8d5dd6dc4b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -156,13 +156,16 @@ When you're ready to submit a pull request: 5. If there's any reason Consul users might need to know about this change, [add a changelog entry](../docs/contributing/add-a-changelog-entry.md). 6. Add labels to your pull request. A table of commonly use labels is below. - If you have any questions about which to apply, feel free to call it out in the PR or comments. - | Label | When to Use | - | --- | --- | - | `pr/no-changelog` | This PR does not have an intended changelog entry | + If you have any questions about which to apply, feel free to call it out in the PR or comments. Other labels may automatically be added by GitHub Actions CI. + + | Label | When to Use | + |----------------------| --- | + | `pr/no-changelog` | This PR does not have an intended changelog entry | + | `pr/no-backport` | This PR does not have an intended backport target | | `pr/no-metrics-test` | This PR does not require any testing for metrics | - | `backport/1.12.x` | Backport the changes in this PR to the targeted release branch. Consult the [Consul Release Notes](https://www.consul.io/docs/release-notes) page to view active releases. Website documentation merged to the latest release branch is deployed immediately | - Other labels may automatically be added by the Github Action CI. + | `backport/1.12.x` | Backport the changes in this PR to the targeted release branch. Consult the [Consul Release Notes](https://www.consul.io/docs/release-notes) page and [`versions.hcl`](/.release/versions.hcl) to view active releases. Website documentation merged to the latest release branch is deployed immediately. See [backport policy](#backport-policy) for more information. | + | `backport/all` | If contributing a bug fix or other change applicable to all branches, use `backport/all` to target all active branches automatically. See [backport policy](#backport-policy) for more information. | + 7. After you submit, the Consul maintainers team needs time to carefully review your contribution and ensure it is production-ready, considering factors such as: security, backwards-compatibility, potential regressions, etc. @@ -174,6 +177,10 @@ When you're ready to submit a pull request: Assuming the tests pass, the PR will be merged automatically. If the tests fail, it is you responsibility to resolve the issues with backports and request another reviewer. +### Backport Policy + +Consul is maintained as a Community Edition (CE) and an Enterprise product. Bug fixes and patches may be backported to the current major release in CE. In Enterprise, bug fixes and patches may be backported to all maintained releases: the N-2 releases and the 2 latest Long-Term Support (LTS) releases. For more information, refer to Consul’s [LTS documentation](https://developer.hashicorp.com/consul/docs/enterprise/long-term-support). + #### Checklists Some common changes that many PRs require are documented through checklists as diff --git a/contributing/INTERNALS.md b/contributing/INTERNALS.md deleted file mode 100644 index 0deb6675cb..0000000000 --- a/contributing/INTERNALS.md +++ /dev/null @@ -1 +0,0 @@ -Moved to [docs/README.md](../docs/README.md). diff --git a/contributing/README.md b/contributing/README.md deleted file mode 100644 index 5ab5e80d30..0000000000 --- a/contributing/README.md +++ /dev/null @@ -1 +0,0 @@ -Moved to [docs](../docs/README.md).