Skip to content
JavaScript
Branch: master
Clone or download
Pull request Compare This branch is 99 commits behind wip:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
lib
test
.env.example
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
HOW_IT_WORKS.md
LICENSE
README.md
index.js
now.json
package.json
pro-plan-for-free.js

README.md

DO NOT MERGE – as a service.

Uptime Robot status Build Status Coverage Status Greenkeeper badge

WIP bot screencast

By default, WIP is setting a pull request status to pending if it finds one of the following terms in the pull request titles

  • wip
  • work in progress
  • 🚧

The pro plan allows for configuration of both the terms and the locations that the app is looking for the terms. The pending status can be overwritten by adding @wip ready for review to the pull request body.

🤖📯 If you use the WIP app we strongly recommend to subscribe to the updates

Configuration

Repositories belonging to an account or organization with a Pro plan subscription can be configured by creating a .github/wip.yml file. Two options can be configured

  1. locations: any of title (pull request title), label_name and commit_subject (1st line of the pull request’s commit messages). Default: title
  2. terms: list of strings to look for in the defined locations. All terms are case-insensitive. Default: "wip", "work in progress" and "🚧"

Example:

locations:
- title
- label_name
- commit_subject
terms:
- do not merge
- 

The above configuration makes WIP look for "do not merge" and "⛔️" in the pull request title, all assigned label names and all commit subjects.

You can also configure different terms for different locations:

- terms: 
  locations:
  - title
  - label_name
- terms:
  - fixup!
  - squash!
  locations: commit_subject

The above configuration looks first for ⛔️ in the pull request title and assigned label names. After that it looks for fixup! and squash! in the commit subjects.

About WIP

Besides being a hopefully useful GitHub application, the WIP app is also meant as a reference implementation (source code). I try to keep the complexity low and the code easy to follow. If you are thinking of creating your own GitHub app, the WIP might be a good starting point for you.

Besides the code, I also made our policies good templates for your app.

All revenue from the "pro" plan will be donated to Rails Girls Summer of Code. I only added the paid plan to make the WIP a real-life GitHub App example. If you cannot pay but depend on the pro features you can add your account with an explanation to the pro-plan-for-free.js file.

If you have any questions, please don’t hesitate to create an issue.

Credits

The WIP app was created by Gregor Martynus. You can follow him on twitter at @gr2m.

The logo was created by Micah Ilbery.

Legal

License: Apache 2.0. Privacy Policy. Security Policy. Code of Conduct

You can’t perform that action at this time.