Files
probot.github.io/_apps/commitlint-bot.md
2017-11-03 06:20:26 +02:00

2.5 KiB

title, description, slug, screenshots, authors, repository, host
title description slug screenshots authors repository host
commitlint-bot A GitHub App that lints all commits of new or edited pull requests and sets an appropriate status check. commitlint-bot
https://github.com/ahmed-taj/commitlint-bot/blob/master/docs/status.png
ahmed-taj
ahmed-taj/commitlint-bot https://commitlint.now.sh/

commitlint-bot

Travis npm

commitlint-bot logo

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:

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-bot status check to pass before merging:

branch-protection-screenshot

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() 👆

License

MIT © Ahmed T. Ali