CommitCheck Documentation

Contents


Setup Guide

This guide explains how to setup CommitCheck for your project.

Signup and add your regex

1. Signing up is easy, just click on one of the 'Sign in with Github' buttons on the homepage.

Homepage

2. CommitCheck will ask you to authenticate with Github, this is all that's needed to create an account with CommitCheck. Simply sign in with your Github credentials.

Github omniauth

After registering or signing in, you'll be taken to the admin panel where you can specify a matcher (see section on matchers for help).

Admin panel

Add the CommitCheck GitHub App to your project

After signing up and adding a matcher, you need to allow your Github project to talk to CommitCheck.

1. Go to the CommitCheck App homepage and click 'configure'.

Github app homepage

2. Then choose which organisation you'd like to configure CommitCheck for

Github app configure

2. Next you can choose whether you want CommitCheck to have access to all repos or specific repos. The app will also show you which permissions CommitCheck requires.

Github app setup page

3. Once that's all done, you'll see CommitCheck added to your personal settings.

Github app success page

If you have any problems setting this up, please send a message.


Matchers

CommitCheck supports any ruby regular expression. I recommend Rubular for testing a regex. Here are some examples:

JIRA ticket number regex

\[[A-Z]{3}-\d*\] will match on a JIRA number of the format "ABC-123".

Multiline commit messages

(?=.*Jira Ticket number: )(?=.*What does this address\?)(?=.*What was the solution\?) will match the following commit message:

"Jira Ticket number: RSB-111
What does this address? A new feature.
What was the solution? Some awesome code."


Anything Else..

If you would like to request any other regex examples or suggest any features,
please send a message.