This bot is deprecated and is planned for shutdown August 13, 2025.
We suggest looking into a supported GitHub actions implementation. You can find a few options: https://github.com/marketplace?query=commitlint&type=actions
A GitHub App built with Probot that lints commit messages based on conventionalcommits.org
# Install dependencies
npm install
# Run the bot
npm startThe following configuration settings can be set by creating a
.github/conventional-commit-lint.yaml file:
| Name | Description | Default |
|---|---|---|
| enabled | Should commit linting be enabled? | boolean = true |
| always_check_pr_title | If set to true, the bot will use the PR title | boolean = false |
This bot uses nock for mocking requests to GitHub, and snap-shot-it for capturing responses; This allows updates to the API surface to be treated as a visual diff, rather than tediously asserting against each field.
Running tests:
npm run testTo update snapshots:
npm run test:snapIf you have suggestions for how conventional-commit-lint could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the Contributing Guide.
Apache 2.0 © 2019 Google Inc.