Repository files navigation

Built withprobot framework

A GitHub App that runscommitlint against all commits of new or edited pull requestsand sets an appropriate status check.

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

On the next pull request, a status check fromcommitlint 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 thecommitlint status check to pass before merging:

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

1. Setup the repo:

git clone https://github.com/z0al/commitlint-bot.gitcd commitlint-botnpm install

2. Create your ownGitHub app
3. Store the private key asprivate-key.pem somewhere safe, and point to its location in.env
4. Start the app withAPP_ID=1234 npm start where1234 is your GitHub app's ID
5. Update your GitHub app's Webhook URL to your localtunnel.me URL

Seedocs/deploy.md for more info.

Robot designed byFreepik.

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

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

MIT ©Ahmed T. Ali