A Github Bot that has a love for furry things and will help with day to day tasks
A huge shout out to inspiration Derek created by Alex Ellis. If you need something for production work flows, I suggest having a look and sponsoring
If you would like to install Paul, you can find him in the Github Apps.
Please Note Paul is currently in Alpha. Backwards incompatible changes can occur. There also might be times where you will need to update permissions based on newly released features.
Commands:
/approve
: Paul will approve a Pull Request (conditions: must be a maintainer in PAUL.yaml)/merge
: Paul will merge the Pull Request (conditions: must be a maintainer in PAUL.yaml)/label <some-label>
: Paul will label the issue/PR with that label (conditions: must be maintainer and label must exists)/remove-label <some-label>
: Paul will remove a label from a issue/PR (conditions: must be maintainer in PAUL.yaml and label must exists)/dog
: Paul will add and image of a dog/cat
: Paul will add an Image of a cat/giphy <some description>
: Paul will fetch a giphy that matches the description and add it to the PR/Issue (only single word descriptions are currently supported)/assign @Spazzy757 @OtherUser
: Paul will add all users that are in the maintainers lists as reviewersOther Functions:
merge
will be automatically merged every hour if they are mergeable. This means that you can mark a Pull Requests as mergeable before all required checks have passed and once they have passed Paul will merge the Pull RequestPaul is configured using the PAUL.yaml
in the .github/
directory of your default branch:
maintainers:
- Spazzy757
# Allows for the /label and /remove-label commands
# usage: /label enhancement
# usage: /remove-label enhancement
# Will only add existing labels
# Can be used on PR's or Issues
labels: true
# Settings for branch destroyer
# branch destroyer will not delete your default branch
branch_destroyer:
enabled: true
# set other "protected" branches here
protected_branches:
- main
pull_requests:
# Enableds the /assign command
assign: true
# Enables DCO check on commits
dco_check: true
# Enables Verified Commits check on commits
verified_commit_check: true
# The Setting to enable automaed merges
automated_merge: true
# The time in days after a PR should be labeled inactive
stale_time: 15
# This will limit the amount of PR's a single contributer can have
# Limits work in progress
limit_pull_requests:
max_number: 3
# This is the message that will displayed when a user opens a pull request
open_message: |
Greetings! Thanks for opening a PR
# Enables the /cat command
cats_enabled: true
# enables the /dog command
dogs_enabled: true
# Allows any maintainer in the list to run /approve
# Paul will approve the PR (Does not merge it)
allow_approval: true
# enables the /giphy command
giphy_enabled: true
If you would like to contribute, have a look at the CONTRIBUTING.md