search

ammar-knowledge / com-lint

MIT License
0 stars 0 forks source link

readme

com-lint [bot]

npm

npm

commitlint logo

Built with probot framework

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

Usage

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

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

status-check-screenshot

Problem details will be reported as a comment like this:

status-comment-screenshot

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

branch-protection-screenshot

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/Ammar-Knowledge/com-lint.git
cd com-lint
npm install
  1. Create your own GitHub app
  2. Store the private key as private-key.pem somewhere safe, and point to its location in .env
  3. Start the app with APP_ID=1234 npm start where 1234 is your GitHub app's ID
  4. Update your GitHub app's Webhook URL to your localtunnel.me URL

Deployment

See docs/deploy.md for more info.

Credits

Robot designed by Freepik.

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

License

MIT © Ammar-Ahmed-Butt