Skip to content
This repository has been archived by the owner. It is now read-only.
[UNMAINTAINED] validate-commit-msg aaS
JavaScript Shell Vim script
Branch: master
Clone or download
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.
docs
scripts
.editorconfig
.gitattributes
.gitignore
.npmrc
.travis.yml
.vimrc
.yo-rc.json
LICENSE
README.md
index.js
package-lock.json
package.json

README.md

validate-commit-msg-bot

Build Status npm version License Unmaintained

UNMAINTAINED. Please migrate your projects to commitlint-bot.

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.

You can’t perform that action at this time.