DO NOT MERGE – as a service.
By default, WIP is setting a pull request status to pending if it finds one of the following terms in the pull request titles
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.
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
- locations: any of
title(pull request title),
commit_subject(1st line of the pull request’s commit messages). Default:
- terms: list of strings to look for in the defined locations. All terms are case-insensitive. Default:
work in progressand
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
squash! in the commit subjects.
Besides being a hopefully useful GitHub application, the WIP app is also meant as a reference implementation. 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
If you have any questions, please don’t hesitate to create an issue.
The logo was created by Micah Ilbery.