matticusau/PR Helper
Powerful Pull Request automation - auto labels, comment & review automation, rule based auto merge
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| repo-token | The GITHUB_TOKEN secret to use with authenticating. If you require additional permissions use a PAT stored as a secret on your repo. | yes | — |
| enable-prmerge-automation | Set to true to enable the auto merge capabilities | yes | — |
| enable-prcomment-automation | Set to true to enable the PR/Issue comment automation | yes | — |
| enable-prlabel-automation | Set to true to enable the PR label automation | yes | — |
| enable-prreviewer-frontmatter | Set to true to enable reviewers to be set from owner in YAML front matter | no | false |
| enable-welcomemessage | Set to true to automatically send a welcome message to new contributors | yes | — |
| welcome-message | The custom welcome message to send to new contributors | no | Thanks for opening an issue! Make sure you've followed CONTRIBUTING.md. |
| prmerge-requireallchecks | Set to true if all checks need to complete before auto merging | no | false |
| prmerge-requirereviewcount | Should match the setting in your GitHub repo. Set it to -1 to disable. | no | -1 |
| prmerge-method | The method to use when merging the PRs | no | merge |
| prmerge-pathcheck | Set to true to require a path check for auto merge capabilities | no | — |
| prmerge-allowpaths | Provide the path globs which will allow auto merge. JSON object as string, example format {"any":["docs/**"]}. | no | "" |
| prmerge-deletebranch | If true then the branch will be deleted on merge | no | false |
| prmerge-deletebranch-config | Provide the branch patterns which will allow/deny auto delete on merge. JSON object as string, example format {"deny":["dev"]}. | no | "" |
| prreviewer-authorkey | The key in the YAML front matter to define the article author(s), who will be assigned as reviewers | no | author |
| prreviewer-githubuserfromauthorfile | Enables the lookup of the author from the Jekyll style Author YAML file | no | false |
| prreviewer-authorfilepath | Provides the ability to configure the path to the Jekyll authors YAML file to use in lookup | no | docs\_data\authors.yml |
| prreviewer-bypassforfileowner | If set to true, bypass review checks when all the changed files are owned by the author of the PR. | no | false |
| prlabel-default | The initial label to set on PRs when first created | no | pr-onhold |
| prlabel-ready | The label to use when the PR has been signed off and ready for merge | no | pr-ready |
| prlabel-onhold | The label to use when the PR is on hold | no | pr-onhold |
| prlabel-reviewrequired | The label to use when the PR requires reviews | no | review-required |
| prlabel-automerge | The label to set on PRs when it qualifies for automatic merge by this action | no | qualifies-auto-merge |
Outputs
no outputs