https://github.com/carloscastrojumo/github-cherry-pick-action
GitHub action for cherry pick commits from Pull Requests into Release branchs
https://github.com/carloscastrojumo/github-cherry-pick-action
cherry-pick github github-action github-actions pull-requests
Last synced: 24 days ago
JSON representation
GitHub action for cherry pick commits from Pull Requests into Release branchs
- Host: GitHub
- URL: https://github.com/carloscastrojumo/github-cherry-pick-action
- Owner: carloscastrojumo
- License: mit
- Created: 2021-02-24T17:40:35.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2026-02-11T17:16:58.000Z (about 2 months ago)
- Last Synced: 2026-02-14T19:47:30.762Z (about 2 months ago)
- Topics: cherry-pick, github, github-action, github-actions, pull-requests
- Language: TypeScript
- Homepage:
- Size: 1.11 MB
- Stars: 61
- Watchers: 1
- Forks: 42
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Cherry-picking a pull request commit into branchs
This action is designed to be used for cherry-pick commits from pull requests into release branches.
GitHub Cherry Pick Action will:
- Checkout triggered action.
- Create new branch name `cherry-pick-${GITHUB_SHA}` from `branch` input.
- Cherry-picking `${GITHUB_SHA}` into created `branch`
- Push new `branch` to remote
- Open pull request to `branch`
> _NOTE:_ The `GITHUB_SHA` is taken from the GitHub context, specifically from the `merge_commit_sha` attribute of the pull request object.
## Example
Cherry-picking pull requests merged on main to branch _release-v1.0_ in pull requests labeled with **release-v1.0** and to branch _release-v2.0_ in pull requests labeled with **release-v2.0**.
```yml
on:
pull_request:
branches:
- main
types: ['closed']
jobs:
cherry_pick_release_v1_0:
runs-on: ubuntu-latest
name: Cherry pick into release-v1.0
if: ${{ contains(github.event.pull_request.labels.*.name, 'release-v1.0') && github.event.pull_request.merged == true }}
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Cherry pick into release-v1.0
uses: carloscastrojumo/github-cherry-pick-action@v1.0.1
with:
branch: release-v1.0
labels: |
cherry-pick
reviewers: |
aReviewerUser
cherry_pick_release_v2_0:
runs-on: ubuntu-latest
name: Cherry pick into release-v2.0
if: ${{ contains(github.event.pull_request.labels.*.name, 'release-v2.0') && github.event.pull_request.merged == true }}
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Cherry pick into release-v2.0
uses: carloscastrojumo/github-cherry-pick-action@v1.0.1
with:
branch: release-v2.0
labels: |
cherry-pick
reviewers: |
aReviewerUser
title: '[cherry-pick] {old_title}'
body: 'Cherry picking #{old_pull_request_id} onto this branch'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
### Using outputs:
```yml
steps:
- uses: actions/checkout@v3
- uses: carloscastrojumo/github-cherry-pick-action@v1.0.1
id: new-issue
with:
branch: release-v2.0
labels: cherry-pick
- run: |
echo "${{ steps.new-issue.outputs.data }}"
echo "${{ steps.new-issue.outputs.number }}"
echo "${{ steps.new-issue.outputs.html_url }}"
```
### Working with forked repositories
If you are using this action while working with forked repositories (e.g. when you get pull requests from external contributors), you will have to adapt the trigger to avoid permission problems.
In such a case you should use the `pull_request_target` trigger, which was introduced by github for this usecase.
### Example
```yml
on:
pull_request_target:
branches:
- main
types: ["closed"]
...
```
Mor informatoin can be found in the [GitHub Blog](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/#improvements-for-public-repository-forks)
### Action inputs
| Name | Description | Default |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `token` | `GITHUB_TOKEN` or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` |
| `committer` | The committer name and email address in the format `Display Name `. Defaults to the GitHub Actions bot user. | `GitHub ` |
| `author` | The author name and email address in the format `Display Name `. Defaults to the user who triggered the workflow run. | `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>` |
| `branch` | Name of the branch to merge the cherry pick. | `create-pull-request/patch` |
| `inherit_labels` | Set true or false to inherit labels from the original pull request to the new cherry pick pull request. |
| `labels` | A comma or newline-separated list of labels. | |
| `assignees` | A comma or newline-separated list of assignees (GitHub usernames). | |
| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | |
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. | |
| `title` | Title of the new pull request, the special string `{old_title}` will be substituted for the title of the pull request which triggered the action | [Triggering pull request title] |
| `body` | Body of the new pull request, the special string `{old_pull_request_id}` will be substituted for the ID of the pull request which triggered the action | [Triggering pull request body] |
| `cherry-pick-branch` | Name of the new cherry pick branch | `cherry-pick-${inputs.branch}-${commitSha}` |
| `force` | Set true or false to forcefully push the cherrypicked changes branch to remote branch. | false |
### Action outputs
| output | value |
| -------- | ----------------------------------------------------------------------------- |
| data | [See Response](https://docs.github.com/en/rest/issues/issues#create-an-issue) |
| html_url | the issue's web url |
| number | the issue's number |
## License
[MIT](LICENSE)