validate-commit-msg-bot

1.0.2 • Public • Published

validate-commit-msg-bot

Build Status npm version License

robot

validate-commit-msg aaS

Runs validate-commit-msg over all commits of new or edited pull requests and sets an appropriate a status check.

Send a PR to tlvince-sandbox-validate-commit-msg-bot to see it in action.

Usage

  1. Browse to GitHub Apps - validate commit msg
  2. Accept the permissions
  3. Allow access to repositories

On the next pull request, a status check from validate-commit-msg-bot will appear:

status-check-screenshot

For best results, enable branch protection (in the repository's settings) and require the validate-commit-msg status check to pass before merging:

branch-protection-screenshot

Development

  1. Setup the repo:

    git clone https://github.com/tlvince/validate-commit-msg-bot.git
    cd validate-commit-msg-bot
    npm install
  2. Create your own GitHub app

  3. Store the private key as private-key.pem in the repo

  4. Start the app with APP_ID=1234 npm start where 1234 is your GitHub app's ID

  5. Update your GitHub app's Webhook URL to your localtunnel.me URL

Author

© 2017 Tom Vincent git@tlvince.com (https://tlvince.com)

License

Released under the MIT license.

Robot emoji courtesy of EmojiOne.

Package Sidebar

Install

npm i validate-commit-msg-bot

Weekly Downloads

0

Version

1.0.2

License

MIT

Last publish

Collaborators

  • tlvince