commitlint-bot

Built with probot framework

A GitHub App that runs commitlint over all commits of new or edited pull requests and sets an appropriate status check.

Usage

1. Browse to GitHub Apps - commitlint-bot
2. Accept the permissions
3. Allow access to repositories

On the next pull request, a status check from commitlint-bot will appear:

Problem details will be reported as a comment like this:

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

What is missing?

We don't currently support custom configuration (i.e. .commitlint.yml or .commitlint.json), but we will

Development

1. Setup the repo:

git clone https://github.com/ahmed-taj/commitlint-bot.git
cd commitlint-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

Credits

Robot designed by Freepik.

Inspired by the awesome work of Tom Vincent in their validate-commit-msg-bot package.

Like it?

Give it a star(:star:) :point_up_2:

License

MIT © Ahmed T. Ali