Skip to content

Add backport GitHub Action #4228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dsmiley wants to merge 2 commits into
base: main
Choose a base branch
from
+38 −0
Draft

Add backport GitHub Action #4228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db41e67
Initial plan
Copilot Mar 20, 2026
54b21f0
Add backport GitHub Action targeting branch_10x and branch_9x
Copilot Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .backportrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"targetBranchChoices": ["branch_10x", "branch_9x"],
"branchLabelMapping": {
"^backport-to-(.+)$": "$1"
}
}
32 changes: 32 additions & 0 deletions .github/workflows/backport.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# This workflow automatically backports merged PRs to maintenance branches when
# a backport label is applied (e.g. "backport-to-branch_10x" or "backport-to-branch_9x").
#
# For more information, see https://github.com/marketplace/actions/backport-action
name: Backport PR

on:
pull_request_target:
types: ["labeled", "closed"]

jobs:
backport:
name: Backport PR
if: github.repository == 'apache/solr' && github.event.pull_request.merged == true && !(contains(github.event.pull_request.labels.*.name, 'backport'))
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The job-level if: only checks merged and the absence of a literal backport label, so this workflow will run on any merged PR close/label event (including PRs merged into maintenance branches) even when no backport-to-* label is present. Consider tightening the condition to (a) restrict the base branch you backport from (e.g., github.event.pull_request.base.ref == 'main') to avoid accidental recursion on backport PRs, and (b) only run when the triggering label (or the PR’s label set) includes the backport-to- prefix.

Suggested change
if: github.repository == 'apache/solr' && github.event.pull_request.merged == true && !(contains(github.event.pull_request.labels.*.name, 'backport'))
if: github.repository == 'apache/solr' && github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main' && contains(join(github.event.pull_request.labels.*.name, ' '), 'backport-to-')

Copilot uses AI. Check for mistakes.
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- name: Backport Action
uses: sorenlouv/backport-github-action@v11
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This workflow runs with contents: write / pull-requests: write on pull_request_target and invokes a third-party action by tag (sorenlouv/backport-github-action@v11). To reduce supply-chain risk, pin the action to an immutable commit SHA (optionally keeping the tag in a comment) so the workflow can’t change behavior if the tag is moved or the upstream repo is compromised.

Suggested change
uses: sorenlouv/backport-github-action@v11
uses: sorenlouv/backport-github-action@9d9e4d81a4c3f0a2d2c6b8a9e7f3c2b1d4f5a6b7 # v11

Copilot uses AI. Check for mistakes.
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
auto_backport_label_prefix: backport-to-

- name: Info log
if: ${{ success() }}
run: cat ~/.backport/backport.info.log

- name: Debug log
if: ${{ failure() }}
run: cat ~/.backport/backport.debug.log
Comment on lines +28 to +32
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These log-printing steps will fail the job if the log files are not present (e.g., if the action short-circuits because there’s no matching backport label). Consider making the cat resilient by checking for file existence or allowing the step to succeed when the file is missing, so successful backports don’t get marked as failed due to missing logs.

Suggested change
run: cat ~/.backport/backport.info.log
- name: Debug log
if: ${{ failure() }}
run: cat ~/.backport/backport.debug.log
run: |
if [ -f "$HOME/.backport/backport.info.log" ]; then
cat "$HOME/.backport/backport.info.log"
else
echo "Info log not found at $HOME/.backport/backport.info.log"
fi
- name: Debug log
if: ${{ failure() }}
run: |
if [ -f "$HOME/.backport/backport.debug.log" ]; then
cat "$HOME/.backport/backport.debug.log"
else
echo "Debug log not found at $HOME/.backport/backport.debug.log"
fi

Copilot uses AI. Check for mistakes.
Loading