actions-marketplace-validations/Update PR Branch
Automatically update the branch of newest (by default) ready to merge PR. Designed to work with the auto-merge option.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| base | The base branch that this action will use to get PRs | yes | master |
| direction | The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when `sort` is `created` or `sort` is not specified, otherwise `asc`. | no | — |
| required_approval_count | The action will skip PRs that have less approvals than this value | yes | 2 |
| require_passed_checks | If the action should skip PRs that have failed checks, defaults to `true`. Please note that if `allow_ongoing_checks` is not set to `true`, the action will skip pull requests with ongoing checks. This may result in the failure to update PR branches when the action is triggered while checks for those pull requests are still in progress. | no | true |
| allow_ongoing_checks | If the action should consider PRs that have ongoing checks, defaults to `false`. The action will consider PRs that have ongoing checks. This is useful when the action is triggered while checks for some otherwise qualified PRs are still in progress. Note, this option works only when `require_passed_checks` is set to `true`. | no | false |
| require_auto_merge_enabled | When set to false, the action includes PRs without auto-merge; the default true excludes such PRs. | no | true |
| sort | What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). | no | — |
| token | The GitHub personal access token | yes | — |
| included_labels | A comma-separated list of labels that the action will consider. If a PR has any of the labels, the action will consider it. | no | — |
Outputs
no outputs