Commit Cop

GitHub status check that ensures your pull requests and commits are looking good

Enforces commit styling

Installation

github.com/apps/commit-cop

How it works

Commit Cop looks for a conventional commit format in:

1. the PR title
2. some or all PR commit

Commit Cop also makes sure a BREAKING CHANGE is followed by a colon : It will enforce this in both:

1. the PR body
2. any commit message

Commit Cop can also be configured to ensure that JIRA tickets are prepended:

• ✅ - "ABCD-1234 - feat(scope): subject"
• ✅ - "ABCD-5678 - feat: subject"

If JIRA tickets are not required then Commit Cop will ignore characters up till the commit type:

• ✅ - "TICKET#12412312 feat(scope): subject"
• ✅ - "some stuff we prepend feat: subject"

All features can be toggled by optionally adding a commit-cop.yml file to the .github directory of your repo:

requireTitle: true
requireCommits: 'some'
requirePrBreakingChangeColon: true
requireCommitBreakingChangeColon: true
requireJira: true

Note: ☝️ those are the defaults

requireTitle - boolean

• Set to true to require the title of your PR to be enforced

requireCommits - 'none' | 'some' | 'all'

• Set to 'some' to require at least 1 of the original commits to be enforced (good for squashes).
• Set to 'all' to have all commits in the PR enforced (good for merges)
• Set to 'none' to not have commits enforced

requirePrBreakingChangeColon - boolean

• Set to true to require BREAKING CHANGE found in the PR body to be followed by a colon :

requireCommitBreakingChangeColon - boolean

• Set to true to require BREAKING CHANGE found in the any commit message to be followed by a colon :

requireJira - boolean

• Set to true to require a jira ticket be prepended to the commit message in the ALPHACAPS-number format: "WORD-1234 - "
  • ✅ - "DEV-111 - feat(scope): subject"
  • ✅ - "DEV-4234 - feat: subject"

allowedScopes - string[] (optional)

• Provide a list of strings that are acceptable scopes. Commits containing scopes that are not present in the allowedScopes array will be rejected
• Not providing any allowedScopes in the yaml will result in any scopes being acceptable.

License

Apache 2.0