Skip to content

Commit

Permalink
docs: add merge_commits input
Browse files Browse the repository at this point in the history
  • Loading branch information
korthout committed Aug 15, 2023
1 parent 64bdda3 commit 110cfbc
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Expand Up @@ -140,6 +140,16 @@ The action will backport the pull request to each matched target branch.
Note that the pull request's headref is excluded automatically.
See [How it works](#how-it-works).

### `merge_commits`

Default: `fail`

Specifies how the action should deal with merge commits on the merged pull request.

- When set to `fail` the backport fails when the action detects one or more merge commits.
- When set to `skip` the action only cherry-picks non-merge commits, i.e. it ignores merge commits.
This can be useful when you regularly [update your pull requests with a merge commit](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch).

### `pull_description`

Default:
Expand Down

0 comments on commit 110cfbc

Please sign in to comment.