Deploying¶

If you would like to run your own instance of this plugin, you can do so by forking this repo and deploying it to your own servers or run it locally

The Probot deployment guide describes this as well

Create a GitHub App and configure the permissions & events with the following:

Settings:

GitHub app name - Your app name
Webhook URL - Your webhook url for listening to events (for local deployments you can use smee.io))
Webhook secret - Your generated webhook seceret (GitHub app page has instructions on how to create this)

Permissions:

Checks - Read & Write
Issues - Read & Write
Repository metadata - Read Only
Pull requests - Read Only
Commit Statuses - Read & Write
Single File - Read-only * Path: .github/mergeable.yml
Repository Contents - Read-Only
Repository projects - Read-Only

And subscription to the following events:

[x] Pull request
[x] Pull request review comment
[x] Pull request review
[x] Issues

Make sure to create a private key for the app after it’s been registered.

Running Locally¶

Clone the forked repository on to your machine
Globally install smee-client from with npm npm install -g smee-client
Go to smee.io and create a new webhook OR use the cli by running the smee command.
Copy .env.template to a new file called .env, and fill it out.
Run npm run dev in your local repository
Add a repository for your Github app by going to application settings
Do a test pull request to check if everything is working

Note: if you wish to use a different config file name besides mergeable.yml, use the CONFIG_PATH environment variable. Config files use .github as base path, see here.

Possible Issues¶

400 bad request / Error: No X-Hub-Signature found on request

This happens when you haven’t configured the webhook secret correctly in your locally running instance. Make sure to set the SECRET_TOKEN environment variable in .env before running npm run dev.

Note

For a list of possible configurable variables within mergeable, check configurable-variables-page