https://github.com/tibdex/backport

🔙 GitHub Action to backport pull requests
https://github.com/tibdex/backport

backport github-action javascript-github-action pull-requests

Last synced: 29 days ago
JSON representation

🔙 GitHub Action to backport pull requests

• Host: GitHub
• URL: https://github.com/tibdex/backport
• Owner: tibdex
• License: mit
• Created: 2018-09-11T03:18:00.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-31T15:10:55.000Z (3 months ago)
• Last Synced: 2024-09-25T01:01:58.339Z (about 2 months ago)
• Topics: backport, github-action, javascript-github-action, pull-requests
• Language: TypeScript
• Homepage:
• Size: 2.07 MB
• Stars: 73
• Watchers: 4
• Forks: 65
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Backport is a [JavaScript GitHub Action](https://help.github.com/en/articles/about-actions#javascript-actions) to backport a pull request by simply adding a label to it.

It can backport [rebased and merged](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#rebase-and-merge-your-pull-request-commits) pull requests with a single commit and [squashed and merged](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#squash-and-merge-your-pull-request-commits) pull requests.

It thus integrates well with [Autosquash](https://github.com/marketplace/actions/autosquash).

# Usage

1.  :electric_plug: Add this [.github/workflows/backport.yml](.github/workflows/backport.yml) to your repository.

2.  :speech_balloon: Let's say you want to backport a pull request on a branch named `production`.

    Then label it with `backport production`. (See [how to create labels](https://help.github.com/articles/creating-a-label/).)

3.  :sparkles: That's it! When the pull request gets merged, it will be backported to the `production` branch.

    If the pull request cannot be backported, a comment explaining why will automatically be posted.

_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`.