From 89f934cdf4e08579080146f267893668bdcf83cf Mon Sep 17 00:00:00 2001 From: Jenny Shu <28537278+jenshu@users.noreply.github.com> Date: Mon, 16 Dec 2024 13:11:34 -0500 Subject: [PATCH] add note about backports (#10493) --- changelog/v1.19.0-beta3/backport-changelog-note.yaml | 8 ++++++++ devel/contributing/backports.md | 4 +++- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 changelog/v1.19.0-beta3/backport-changelog-note.yaml diff --git a/changelog/v1.19.0-beta3/backport-changelog-note.yaml b/changelog/v1.19.0-beta3/backport-changelog-note.yaml new file mode 100644 index 00000000000..56f52e2f532 --- /dev/null +++ b/changelog/v1.19.0-beta3/backport-changelog-note.yaml @@ -0,0 +1,8 @@ +changelog: +- type: NON_USER_FACING + description: >- + Add a note about changelogs in backports. + + skipCI-kube-tests:true + skipCI-docs-build:true + diff --git a/devel/contributing/backports.md b/devel/contributing/backports.md index 3079e32bc69..e597c0911c6 100644 --- a/devel/contributing/backports.md +++ b/devel/contributing/backports.md @@ -24,5 +24,7 @@ Once the change has been merged into the main branch, create a PR to backport th - Resolve any conflicts that have arisen due to drift between LTS branches - If there is significant drift that causes the cherry-pick to be non-trivial, consider re-implementing the change from scratch rather than "backporting" - Modify the changelog to be in the proper directory + - Note: In the rare case that a new feature (indicated by `NEW_FEATURE` in the [changelog file](https://github.com/solo-io/go-utils/blob/main/changelogutils/README.md)) is being backported, changelog-bot + will complain with an error similar to `Only one version greater than the latest release valid, found...`. This is because our changelog-bot does not allow `NEW_FEATURE` in a backport/patch release. To get around this error, change the changelog type from `NEW_FEATURE` to `FIX` for backports. - Validate that Proto fields have the same numbers as in main -- Title your pr to start with the major.minor version that you are backporting to (e.g. 1.13 for 1.13.x branch) \ No newline at end of file +- Title your PR to start with the major.minor version that you are backporting to (e.g. 1.13 for 1.13.x branch) \ No newline at end of file