A bot to take the pain out of Contributor License Agreements
npm install ketan-clabotclabot automatically checks Pull Requests submitted to your repository.
If the sender hasn't signed the Contributor License Agreement, he comments with instructions, otherwise the maintainer will be notified.
What a CLA is and why you need one
!post fancy gifs like it's 1995
The bot is fully customizeable:
* Hook any API into the getContractors mechanism.
* Provide templates to adapt clabot's comments to your needs
* Flags to ignore pull requests from collaborators or people who have already contributed
You can even trigger clabot manually with a special comment API. Reply with [clabot:check] to any pull request and you'll instantly see wether the sender has signed or not.
This dramatically reduces the time investement needed to establish a strict contribution policy for your projects.
The focus of this project lies on communication automation:
* No more painful begging for replies
* No more hours of processing the pull request queue
* No more manually checking the contractor database
The bot is written in coffeescript, running on node.js. Due to pubsubhubhub and GitHub's live updates answers will appear almost instantly.
Feel free to open pull requests in our sandbox environment.
Experience how clabot automatically responds, guiding you through the process of signing a Contributors License Agreement.
Note: If you don't want to go through the hassle of forking the repo just reply [clabot:check] to any of the pull requests.
You can use [clabot:check=yourusername] to check your own status.
You'll probably never have to hack on this repo directly.
Instead this repo provides a library that's distributed by npm that you simply require in your project.
We have set up a sample implementation. Look at the code there or fork our boilerplate and follow the tutorial.
clabot is available on the npm registry.
``bash`
npm install clabot
You require clabot and call clabot.createApp(options). This will return a new express.js app.
Based on the options provided this already sets up some clabot specific routes and middlewares.
All you have to do is listen to a port and clabot will be up and running.
`js`
app = require('clabot').createApp(options);
app.listen(process.env.PORT || 1337);
If your app requires middleware to be added before clabot's middleware, you can pass in an Express app for clabot to use instead of creating a new one.
`js`
options.app = express();
// add some middleware here
app = require('clabot').createApp(options);
app.listen(process.env.PORT || 1337);
In order to receive events from GitHub you have to subscribe.
clabot will never push code to the repositories, but push access is required to be able to receive events from the GitHub API.
`bash
curl -u "clabotusername" -i https://api.github.com/hub -F "hub.mode=subscribe" -F "hub.topic=https://github.com/:user/:repo/events/pull_request" -F "hub.callback=http://your-clabot.herokuapp.com/notify" -F "hub.secret=supersecretrandomstring"
curl -u "clabotusername" -i https://api.github.com/hub -F "hub.mode=subscribe" -F "hub.topic=https://github.com/:user/:repo/events/issue_comment" -F "hub.callback=http://your-clabot.herokuapp.com/notify" -F "hub.secret=supersecretrandomstring"
`
Note: You have to do both of the commands for every repository that should be observed. One command for pull requests and one for comments on those.
http://developer.github.com/v3/repos/hooks/#pubsubhubbub
#### getContractors(callback)
Type: Function
required
This function will be called by clabot in case he needs a list of all signed contractors.
Provide a function here that queries your database and calls the callback with an array of GitHub usernames.
#### addContractor(contractor, callback)
Type: Function
optional
This function will be called by clabot in case he needs to add a contractor to the list of signed contractors.
Provide a function here that adds a contractor to your database and calls the callback with a boolean success flag.
#### token
Type: String
required
A valid GitHub oAuth token with access to all repositories that clabot should observe.
Note: It's highly recommended that you don't commit the token to your repository. Use environment variables.
Note: It's highly recommended that you create a sperate GitHub account for your clabot.
`bash`
curl -u 'clabotusername' -d '{"scopes":["repo"],"note":"clabot"}' https://api.github.com/authorizations
Creating an OAuth token for command-line use
#### templates
Type: Object
optional
clabot provides pretty cool standard templates, but if they don't fit your needs you can specify custom ones.
The object may specify: alreadySigned and notYetSigned. You should have a look at the originals._.template
Note: Templates are processed by lodash's
#### templateData
Type: Object
Specify details displayed in clabot's answers. You may specify any data you like, so you can access it in your custom templates
.
* "image": 'Boolean' show funny gifs in the response
* "link": 'String' link to your electronical submission form
* "maintainer": 'String' GitHub username to be notified, if CLA was signed
#### secrets
Type: Object
required
The secrets you provided when subscribing to GitHub's events. Organized in a user/repo way so you can vary secrets on a per repo basis.
`js`
secrets: {
username:
reponame: 'secret1'
reponame2: 'secret2'
}
Note: It's highly recommended that you don't commit secrets to your repository. Use environment variables.
#### skipCollaborators
Type: Boolean
Default: false
Don't answer to pull request from people with push access to the repository.
#### skipContributors
Type: Boolean`
Default: true
Don't answer to pull request from people who have already contributed to the repository.
Don't know what the whole CLA thing is about?
> The purpose of a CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen licence.
Wikipedia
Need a Contributor License Agreement template?
> Project Harmony is a community-centered group focused on contributor agreements for free and open source software (FOSS) Project Harmony
Wanna hang out and chat about clabot?
clabot is MIT licensed. In case you forgot about the most important part of it:
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
> OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
> HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
> WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
> OTHER DEALINGS IN THE SOFTWARE.
We aren't lawyers, and none of the clabot documentation, functionality, or other communication constitutes legal advice. Consult your lawyer about a Contributor License Agreement.
authored by Stephan Bönnemann - @boennemann
maintained by excellenteasy
clabot logo by Proycontec SL. - Creative Commons Attribution-Share Alike 3.0