GitHub status check that ensures your pull requests follow the Conventional Commits spec
Using semantic-release and conventional commit messages? Install this Probot app on your repos to ensure your pull requests are semantic before you merge them.
Scenario | Status | Status Check Message |
---|---|---|
PR title is semantic | ๐ | ready to be squashed |
any commit is semantic | ๐ | ready to be merged or rebased |
nothing is semantic | ๐ | add a semantic commit or PR title |
Take this PR for example. None of the commit messages are semantic, nor is the PR title, so the status remains yellow:
Edit the PR title by adding a semantic prefix like fix:
or feat:
or any other
conventional commit type. Now use Squash and Merge
to squash the branch onto master and write a standardized commit message while doing so:
๐ github.com/apps/semantic-pull-requests
You can add a semantic.yml
file to your .github
directory with the following
optional settings:
# Only lint the title, ignoring the commits. Useful when squashing as PR title
# is the default squashed commit message.
titleOnly: false