GitHub Action
Cherry-Pick Squashed PRS
This project was inspired by cirrus-actions/rebase and started as a fork of rebase project.
To configure the action simply add the following lines to your .github/workflows/comment-cherry-pick.yml workflow file:
name: Cherry Pick On Comment
on:
issue_comment:
types: [created]
jobs:
cherry-pick:
name: Cherry Pick
if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick')
runs-on: ubuntu-latest
steps:
- name: Checkout the latest code
uses: actions/checkout@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
- name: Automatic Cherry Pick
uses: vendoo/gha-cherry-pick@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}After installation simply comment /cherry-pick <target_branch> to trigger the action:
NOTE: To ensure GitHub Actions is automatically re-run after a successful cherry-pick action use a Personal Access Token for
actions/checkout@v2andvendoo/cherry-pick@v1. See the following discussion for more details.
Example
...
- name: Checkout the latest code
uses: actions/checkout@v2
with:
token: ${{ secrets.PAT_TOKEN }}
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
- name: Automatic Cherry Pick
uses: vendoo/gha-cherry-pick@v1
env:
GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}You can also optionally specify the PR number of the branch to cherry-pick, if the action you're running doesn't directly refer to a specific pull request:
- name: Automatic Cherry Pick
uses: vendoo/gha-cherry-pick@v1
env:
GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}
PR_NUMBER: 1245It's possible to use author_association field of a comment to restrict who can call the action and skip the cherry-pick for others. Simply add the following expression to the if statement in your workflow file: github.event.comment.author_association == 'MEMBER'. See documentation for a list of all available values of author_association.