Mercurial Hook to ensure issue references in Trac/Redmine

david miller — Sat, 04 Jun 2011 10:41:07 +0000

As much as I love the version control integration of the bug trackers I use (Redmine and Trac) I find myself forgetting to include the issue reference more often than I’d like to admit.

Add to this the merry dance you have to go through to ammend commit messages in Mercurial and things get even worse. (Oh how I’d love for hg to implement something similar to git’s $ git commit –amend )

Hence, a Pre-transaction-commit hook for hg that will ask me if I’m sure I want to commit without an issue number. If want to commit anyway, it’s just two extra keystrokes, and saves a whole lot of rollback/apply nonsense.

#!/usr/bin/env python
import os
import re
import subprocess
import sys
 
cmd = subprocess.Popen(['hg', 'log', '-vr', os.environ['HG_NODE']],
                       stdout=subprocess.PIPE).communicate()[0]
msg = cmd.split('description:')[1]
issue_regexes = [
    # Trac
    r'#\d+',
    # Redmine
    r'fixes #\d+',
    r'refs #\d+',
    ]
if not filter(lambda x: re.search(x, msg), issue_regexes):
    print "No issue ref or fix... message is:"
    print msg
    sys.stdout.write("Continue? [y/n] ")
    resp = raw_input().lower()
    if resp == 'n':
        sys.exit(9)

Then add the following to your project’s .hg/hgrc:

[hooks]
pretxncommit = path/to/your/pretxncommit.py

Saving you endless embarrassment:

davidmiller@pascal:~/src/buggy_repo$ hg commit -m "A context-less void"
No issue ref or fix... message is:
 
A context-less void
 
 
 
Continue? [y/n] n
transaction abort!
rollback completed
abort: pretxncommit hook exited with status 9

Love regards etc

Something’s Burning #6

david miller — Thu, 25 Mar 2010 23:02:59 +0000

WE’RE ALL PLANNING

OUR CAREERS

Photo by

quinn.anya

Something’s Burning #4

david miller — Mon, 05 Oct 2009 22:39:24 +0000

LIKE IT WAS HIS TO

GIVE AWAY

Photo by

O’mages

Something’s Burning #3

david miller — Fri, 17 Jul 2009 07:14:13 +0000

I’M NOT JUST

PUSHING YOUR BUTTONS

HERE

Photo by

Storem

something’s burning #2

david miller — Mon, 06 Jul 2009 18:58:13 +0000

SOMETHING SO SEDUCTIVE

ABOUT A PLAN

Photo by

Stephan Geyer

Something’s Burning

david miller — Fri, 03 Jul 2009 20:38:32 +0000

I MISS MY FUTURES.

NARCISSUS VERSUS PROLAPSUS