Install the backport workflow

Tue, 03 Sep 2024 00:00:00 +0000

Install the backport workflow

Before you can backport changes, the repository must have the workflow installed.

Before you begin

Clone the repository.

For more information, refer to Create a repository.

Steps

To install the backport workflow:

Check out a new branch for your changes.

To check out a branch, refer to Create a branch from the default remote branch.

Create the .github/workflows/backport.yml file.

Use the following YAML as the contents of the file. You must update REPOSITORY to be the name of your repository.

name: Backport PR creator
on:
  pull_request_target:
    types:
      - closed
      - labeled

jobs:
  main:
    if: github.repository == 'grafana/<REPOSITORY>'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout actions
        uses: actions/checkout@v4
        with:
          repository: grafana/grafana-github-actions
          path: ./actions
      - name: Install actions
        run: npm install --production --prefix ./actions
      - name: Run backport
        uses: ./actions/backport
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          labelsToAdd: backport
          title: "[{{base}}] {{originalTitle}}"

Commit the file.

For more information, refer to Commit changes to your branch.
Open a pull request for your changes.
After a maintainer merges your pull request, you can backport changes using labels by following the instructions in Backport changes.

Backport changes on Grafana Labs

Install the backport workflow

Install the backport workflow

Before you begin

Steps