Skip to content
copy

GitHub Action

PR Cherry Pick

v1.0.1 Latest version

PR Cherry Pick

copy

PR Cherry Pick

Cherry-picks commits from a merged PR, creating a new PR to a target branch

Installation

Copy and paste the following snippet into your .yml file.

              

- name: PR Cherry Pick

uses: wireapp/action-auto-cherry-pick@v1.0.1

Learn more about this action in wireapp/action-auto-cherry-pick

Choose a version

Automatic cherry-picking

Cherry-picks commits from a merged PR, creating a new PR to a target branch. Allows setting a name of a submodule and will automatically fast-forward it to also match the target-branch.

Check action.yml for a description of inputs and outputs.

Configuration sample:

name: 'Cherry pick Release/candidate into develop'
on:
    pull_request:
        branches:
            - release/candidate # Branches where the original PRs will be merged
        types:
            - closed

jobs:
    test-cherry-pick:
        runs-on: ubuntu-latest
        name: Test the cherry-pick action
        steps:
            - name: Checkout
              uses: actions/checkout@v4
              with:
                  fetch-depth: 0
                  submodules: recursive #If you need to operate on submodules

            - name: Cherry pick
              id: cherry-pick
              uses: wireapp/action-auto-cherry-pick@v1.0.1
              with:
                  target-branch: 'develop' # Branch which will receive the automatic cherry-picks
                  submodules-target-branch: 'develop' # If you want the action to fast-forward the submodules to a specific branch
                  pr-title-suffix: '🍒'

            - name: Get the output
              run:
                  echo "The created PR number is ${{
                  steps.hello.outputs.pr-number }}"