github/combine-prs
Combine multiple PRs into a single PR
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Feb 24, 2025
- License
- MIT
Pinned Snippet
uses: github/combine-prs@2909f404763c3177a456e052bdb7f2e85d3a7cb3 # v5.2.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | The GitHub token used to create an authenticated client - Provided for you by default! | yes | ${{ github.token }} |
| branch_prefix | The prefix of the branches to combine | yes | dependabot |
| pr_title | The title of the pull request to create | yes | Combined PRs |
| pr_body_header | The header of the pull request body | yes | # Combined PRs ➡️📦⬅️ |
| min_combine_number | The minimum number of PRs that have to match criteria in order to create a combined PR | yes | 2 |
| branch_regex | The regex to match the branches to combine - more control than branch_prefix | no | "" |
| ci_required | Whether or not CI should be passing to combine the PR | yes | true |
| review_required | Whether or not a review should be required to combine the PR | no | false |
| combine_branch_name | The name of the branch to combine the PRs into | yes | combined-prs-branch |
| ignore_label | The label to ignore when combining PRs | yes | nocombine |
| select_label | The label marking PRs that should be combined | no | "" |
| labels | A comma seperated list of labels to add to the combined PR | no | "" |
| assignees | A comma seperated list of assignees to add to the combined PR | no | "" |
| autoclose | Whether or not to close combined PRs if the combined PR is merged | no | true |
| update_branch | Whether or not to update the combined branch with the latest changes from the base branch after creating the combined pull request | no | true |
| create_from_scratch | Whether or not to start from a clean base branch when (re)creating the combined PR | no | false |
Outputs
| name | description |
|---|---|
| pr_url | The pull request URL if a PR was created |
| pr_number | The pull request number if a PR was created |