wip-bot

DO NOT MERGE – as a service.

Usage

1. Install the app on your GitHub Repositories: github.com/apps/wip
2. The WIP bot sets status of the request title to pending if it finds "wip", "work in progress" or "do not merge" (not case-sensitive) in
   1. The pull request title
   2. One of the pull request labels
   3. One of the pull request commit messages
3. If it doesn’t find the words anywhere, it will set status to success

Local setup

• Setup repository

  git clone [e-mail]:wip/app.git
  cd wip-bot
  npm install
  

• Create your own GitHub app: instructions

• On your local machine, copy .env.example to .env.

• Go to smee.io and click Start a new channel. Set WEBHOOK_PROXY_URL in .env to the URL that you are redirected to.

• Create a new GitHub App with:

  • Webhook URL: Use your WEBHOOK_PROXY_URL from the previous step.
  • Webhook Secret: development.
  • Permissions & events
    • Commit statuses (read & write)
    • Pull Requests (read only)
    • Subscribe to events Pull request

• Download the private key and move it to your project's directory. It will get picked up by Probot automatically.

• Edit .env and set APP_ID to the ID of the app you just created. The App ID can be found in your app settings page here

• Run $ npm start to start the server/

Contribute

If you’d like to contribute a bug fix or feature to wip-bot, please fork the repository, then clone it to your computer. Then install dependencies and run the tests

npm install
npm test

Before adding a feature, create an issue first to ask if it’s within the scope of the app. If possible, add tests to your pull requests.

Credits

The logo was created by Micah Ilbery.

Legal

License: Apache 2.0. Privacy Policy