Skip to content

jfagoagas/backport-github-action

This branch is up to date with sorenlouv/backport-github-action:main.

Folders and files

NameName
Last commit message
Last commit date
May 9, 2024
Mar 21, 2022
May 9, 2024
May 9, 2024
Feb 1, 2024
May 9, 2024
May 9, 2024
Feb 8, 2022
Aug 18, 2022
Jul 10, 2024
Feb 1, 2024
Oct 9, 2022
May 9, 2024
Feb 9, 2022
May 9, 2024
May 9, 2024

Repository files navigation

Backport Github Action

Getting started

Create a file /.github/workflows/backport.yml with the following content:

name: Automatic backport action

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

jobs:
  backport:
    name: Backport PR
    if: github.event.pull_request.merged == true && !(contains(github.event.pull_request.labels.*.name, 'backport'))
    runs-on: ubuntu-latest
    steps:
      - name: Backport Action
        uses: sorenlouv/backport-github-action@v9.5.1
        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        
          

Now, to backport a pull request, simply apply the label backport-to-production. This will automatically backport the PR to the branch called "production" when the PR is merged.

Configuration

For more fine grained customization, and for the ability to run the Backport Tool as a CLI tool locally, you should create a .backportrc.json file in the root directory:

// .backportrc.json
{
  // example repo info
  "repoOwner": "torvalds",
  "repoName": "linux",

  // `targetBranch` option allows to automatically backport every PR to a specific branch without the need for labels
  "targetBranches": ["production"],

  // the branches available to backport to
  "targetBranchChoices": ["main", "production", "staging"],

  // In this case, adding the label "backport-to-production" will backport the PR to the "production" branch
  "branchLabelMapping": {
    "^backport-to-(.+)$": "$1"
  }
}

See the Backport Tool documentation for all configuration options.

About

Backport CLI tool as a Github Action

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 79.2%
  • JavaScript 16.3%
  • Shell 4.5%