Skip to content

[backport checklist] Add when/why guidance to checklist comment - #20605

Draft
mrodm wants to merge 3 commits into
elastic:mainfrom
mrodm:update_checklist_comment
Draft

[backport checklist] Add when/why guidance to checklist comment#20605
mrodm wants to merge 3 commits into
elastic:mainfrom
mrodm:update_checklist_comment

Conversation

@mrodm

@mrodm mrodm commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Proposed commit message

Add a sentence to the backport checklist comment explaining the core
decision rule ("backport if it fixes existing behavior; leave new
behavior on main") and linking to the Package Backports wiki page for
full context. Developers seeing the checklist for the first time now
have enough information to decide whether to tick a branch without
needing to search for documentation separately.

Author's Checklist

  • Confirm the new sentence renders correctly in a GitHub PR comment preview.

How to test this PR locally

Run the backports test suite:

go test ./dev/backports/...

To eyeball the rendered output, create a minimal artifact file and run mage renderBackportChecklist:

cat <<EOF > pr-packages-test.json
{"number": 1, "packages": ["aws"]}
EOF

mage renderBackportChecklist ./pr-packages-test.json <<< ""

Check that the new guidance sentence and wiki link appear between the intro line and the first package section.

Example of the resulting checklist comment (from mrodm/integrations#78):

Backport branches

[!IMPORTANT]
Only branches for packages touched by this PR's current diff are shown.
This comment is updated automatically on each push — manual edits will be overwritten.

Tick the branches you want to backport to. PRs will be created automatically on merge, or when you update this checklist after merge.

Backport a change when it fixes behavior a branch already has; leave new behavior on main. See when and why to backport if you are unsure.

kubernetes

  • backport-kubernetes-1.83
  • backport-kubernetes-1.62
  • backport-kubernetes-1.39

[!TIP]
If a branch above is no longer required, set archived: true in its entry in .backports.yml to stop it appearing here.
If the branch has a known end-of-life date, prefer maintained_until: "YYYY-MM-DD" — it will be excluded automatically once that date passes.

Related issues


This PR was generated with the assistance of Claude (claude-opus-5).

mrodm and others added 2 commits August 7, 2026 15:05
Add a sentence to the backport checklist comment explaining the core
decision rule ("backport if it fixes existing behavior; leave new
behavior on main") and linking to the Package Backports wiki page for
full context. Developers seeing the checklist for the first time now
have enough information to decide whether to tick a branch without
needing to search for documentation separately.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mrodm mrodm added the enhancement New feature or request label Aug 7, 2026
@mrodm mrodm self-assigned this Aug 7, 2026
@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @mrodm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant