git-risk

A script that allows users of git to determine which ticket(s) included in a merge might be at risk of regressions.

Setup

You will need to add the following section to your .git/config (non-global), or ~/.gitconfig (global) files:

[gitrisk]
  ticketRegex = <ticket regular expression>

<ticket regular expression> can be any regular expression to filter the ticket identifiers out of commit messages. There are some examples in conf/default.conf.

You can add this to your git config easily with:

$ git config [--global] gitrisk.ticketRegex <ticket regular expression>

Usage

git-risk assumes that you have certain data about a series of commits in git. The best way to obtain this information is to run git-risk as a hook within git itself. git-risk can, however, be run as a standalone application from the command line. Both methods are described below.

###Command-Line Usage git-risk [-qm] -c <merge-commit hash>

Where:

• <merge-commit hash> is an SHA hash that was a merge commit
• -q: Flag used to indicate that "quiet" mode should be used, which means only the appropriate ticket(s) will be output.

The output of this command will give you a series of tickets/issues/bugs that can be checked for regressions:

Example (Taken from test repository included in test data/ directory):

$ git-risk ddcdb34
Tickets potentially affected by:
ddcdb34 Merge branch 'bug-14'

Bug #14
Bug #0

Note: The following commits did not have tickets associated with them (or git-risk
couldn't find them), so there might be undocumented issues that have regression(s)
stemming from these commits' interactions with the merge.

c2a881d (No Ticket): Added git-risk-info and renamed README.txt to README.md.

If the -q option had been specified, the output would look more like:

$ git-risk -q ddcdb34
Bug #14
Bug #0

Note that with the -q option, the commit(s) where no ticket was found are not shown. This can potentially lead to problems where regression sources can be masked, so use with caution.

###Hook-based Usage: You can run git-risk within any hook inside of git once a commit is created. This essentially means that only the pre-commit hook can't be used (for the time being) with git-risk. The most logical place to use git-risk is the post-commit hook, which you can setup in the following way:

1. Edit .git/hooks/pre-commit in your source folder (or globally, if you wish to enable it for all git repositories on your local machine).
2. Add the following line to .git/hooks/pre-commit:

   git-risk -m `git rev-list -1 HEAD`