kiegroup/Backporting GitHub Action

GitHub action providing an automated way to backport pull requests from one branch to another

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jun 14, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: kiegroup/git-backporting@08da0b07ef2330d189f6074ec8db736b3aa9f465 # v4.9.1

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
pull-requestURL of the pull request to backport, e.g., "https://github.com/kiegroup/git-backporting/pull/1" no
target-branchComma separated list of branches where the pull request must be backported to no
target-branch-patternRegular expression pattern to extract target branch(es) from pr labels. The branches will be extracted from the pattern's required `target` named capturing group, for instance "^backport (?<target>([^ ]+))$" no
config-filePath to a file containing the json configuration for this tool, the object must match the Args interface no
dry-runIf enabled the tool does not create any pull request nor push anything remotely nofalse
authGITHUB_TOKEN or a `repo` scoped Personal Access Token (PAT), if not provided will look for existing env variables like GITHUB_TOKEN no${{ github.token }}
git-clientGit client type <github|gitlab|codeberg>, if not set it is infered from pull-request no
git-userLocal git user namenoGitHub
git-emailLocal git user emailnonoreply@github.com
titleBackporting PR title. Default is the original PR title prefixed by the target branch no
body-prefixBackporting PR body prefix. Default is `Backport: <original-pr-link>` no
bodyBackporting PR body. Default is the original PR body no
bp-branch-nameComma separated list of backporting PR branch names. Default is auto-generated from commit and target branches no
reviewersComma separated list of reviewers for the backporting pull request no
assigneesComma separated list of reviewers for the backporting pull request no
no-inherit-reviewersConsidered only if reviewers is empty, if true keep reviewers as empty list, otherwise inherit from original pull request nofalse
labelsComma separated list of labels to be assigned to the backported pull request no
inherit-labelsIf true the backported pull request will inherit labels from the original one nofalse
no-squashBackport all commits found in the pull request. The default behavior is to only backport the first commit that was merged in the base branch. no
auto-no-squashIf the pull request was merged or is open, backport all commits. If the pull request commits were squashed, backport the squashed commit. no
strategyCherry-pick merge strategynorecursive
strategy-optionCherry-pick merge strategy optionnotheirs
cherry-pick-optionsAdditional cherry-pick options no
commentsSemicolon separated list of additional comments to be posted to the backported pull request no
enable-err-notificationIf true, enable the error notification as comment on the original pull request nofalse

no outputs