main [bot]

Built with probot framework

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

why

1. Browse to [GitHub Aissionsn
2. Allow access to repositoriess

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

Problem details will be reported as comment like this:

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

Development

1. Setup the repo:

git clone https://github.com/Ammar-Knowledge/main-bot.git
cd main-bot
npm install

2. Create your own GitHub app
3. Store the private key as private-key.pem somewhere safe, and point to its location in .env
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

Deployment

See docs/deploy.md for more info.

Creditss

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 © Ammar Ahmed Butt