Backport is a JavaScript GitHub Action to backport a pull request by simply adding a label to it.
It can backport rebased and merged pull requests with a single commit and squashed and merged pull requests. It thus integrates well with Autosquash.
This action is a fork of https://github.com/tibdex/backport, it adds support for backporting rebase merges and merge commits, squash commits are also supported.
- 🔌 Add this workflow .github/workflows/backport.yml to your repository.
- 💬 Let's say you want to backport a pull request on a branch named
production. Then label it withbackport production. (See how to create labels.) - ✨ That's it! When the pull request gets merged, it will be backported to the
productionbranch. If the pull request cannot be backported, a comment explaining why will automatically be posted and the pull request will be labeled withfailed backport.
Note: multiple backport labels can be added.
For example, if a pull request has the labels backport staging and backport production it will be backported to both branches: staging and production.
Following inputs can be used as step.with keys
| Name | Type | Description |
|---|---|---|
add_labels |
String | Comma separated list of labels to add to the backport PR. |
github_token |
String | Token for the GitHub API. Set this to a personal access token (PAT) of a user which is collaborator with write permissions on the repository to make workflows run on backport pull requests. |
title_template |
String | Template for the title of the opened PR. E.g. [Backport {{base}}] {{originalTitle}} |