A GitHub App built with Probot for approving pull requests automatically
# Install dependencies npm install # Run typescript npm run build # Run the bot npm start
This app requires
Write code permissions in order not to have issues with approving PRs.
Repository administrators can require that all pull requests receive a specific number of approving reviews from people with write or admin permissions in the repository or from a designated code owner before they're merged into a protected branch. ... You won't be able to merge your pull request until the required number of reviewers with write or admin permissions in the repository approve your pull request's changes in their review.
More about it can be found on Github Help.
In order to use the bot, the config file should be provided. Config file should be defined in your repository. Config file is the yml file with the path
.github/autoapproval.yml. The file should have 3 entries.
Defines the list of users, whos pull requests should be approved automatically. For example:
from_owner: - dkhmelenko - quongeri
Assign an empty array if you want to approve PRs from any user (example:
Defines the list of labels on PR, which should be present for approving PR automatically. For example:
required_labels: - ready
Assign an empty array if you want to approve PRs without any label (example:
Defines the list of labels on PR, which will prevent the PR from being automatically approved. For example:
blacklisted_labels: - wip
Assign an empty array if you do not want to blacklist any labels.
Defines the list of labels on PR, which should be added once PR was approved automatically. For example:
apply_labels: - merge
Assign an empty array if no labels should be applied to PRs (example:
- If label doesn't exist, it will not be created. In order to apply the label after approving PR automatically, you need to define the label beforehand.
- If PR already contains all labels from apply_labels config, it will not be approved assuming that it was already approved.
If you have suggestions for how autoapproval could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the Contributing Guide.