@codesherpas/titlelint

GitHub Application to block merging Pull Requests that are a Work in Process

Usage no npm install needed!

<script type="module">
  import codesherpasTitlelint from 'https://cdn.skypack.dev/@codesherpas/titlelint';
</script>

README

Why?

We found this app to be useful if you are using Jira or conventional commit. Ensure a pull request is linked to a Jira ticket or follows the conventional commit standard before merging.

Default Configuration

titleLint:
  pattern: (feat|fix|docs|chore|style|refactor|perf|test): .*

Features

  • Blocks merging while title doesn't match regex

Why does this app require read/write permission on my repo?

In order for the review from the application to prevent a merge it needs to have write permissions on the repo.
We chose to use pull request reviews instead of status checks since we wanted this to be pull request specific and not specific to a sha.

Quick start

  • Install GitHub Application
  • Add above configuration to .github/gitbots.yml in your repository