Pullie is a GitHub bot that makes your PRs better. It runs as a GitHub App and receives webhook calls whenever a pull request is made against a repo on which the app is installed. Plugins provide handy functionality like linking to Jira tickets, requesting reviews, and commenting about a missing required file change.
Pullie runs on public GitHub or on GitHub Enterprise 2.14 or later. It requires Node.js 14 or later.
The easiest way to run Pullie is to clone this repo and run npm start
. You can do so in a Docker container for easy
deployment.
You must specify configuration values via environment variables. You may do so using a .env
file. See
.env.example
for a sample configuration with full documentation.
Pullie runs as a GitHub App, so if you are installing it on your own GitHub Enterprise instance, you must register a GitHub App there first. Here's how:
GitHub App name: Pullie
Description (optional): Pullie is a GitHub bot that makes your PRs better. It runs as a GitHub App and receives webhook calls whenever a pull request is made against a repo on which the app is installed. Plugins provide handy functionality like linking to Jira tickets, requesting reviews, and commenting about a missing required file change.
Homepage URL: The base URL of your Pullie deployment (e.g. https://pullie.example.com)
User authorization callback URL: Same URL as above
Setup URL (optional): Not needed -- leave this blank
Webhook URL: Your deployment's base URL (e.g. https://pullie.example.com/) (unless WEBHOOK_PATH
is adjusted in
config)
Webhook secret (optional): Choose a random string as your webhook secret (e.g. a random UUID perhaps)
Permissions: Leave all as No access except the following:
.pullierc
Subscribe to events: Leave all unchecked except Pull request
Where can this GitHub App be installed? This is up to you. If you choose Only on this account, other users in your GHE instance will not see your application.
static
folder of the Pullie npm package if you'dNow, you can install your GitHub App on an org or user. Select Install App on the left side of the App's config
page and then press the green Install button on any org(s) and/or user(s) you'd like Pullie to run on. Pullie will
not do anything unless a repo has a .pullierc
file, so it is safe to install across an org.
User docs are available at the docs URL of your Pullie deployment (e.g https://pullie.example.com/docs). Just browse there and you'll see full documentation on installing the App and configuring a repo to work with it.