Git Hook to automate inclusion of JIRA (`[ABC-123]`) formatted ticket ids in your commit message

commit-msg

#!/usr/bin/env ruby
#
# Install via:
# `curl GIST_URL > .git/hooks/commit-msg && chmod u+x .git/hooks/commit-msg`

COMMIT_MESSAGE = File.read(ARGV[0])

def check_commit_message
  message_regex = /\[[A-Z]+-[0-9]+\]/

  unless message_regex.match(COMMIT_MESSAGE)
    attempt_extract_from_branch_name
  end
end

def attempt_extract_from_branch_name
  branch_regex = /[A-Z]+-[0-9]+/
  branch_name = `git symbolic-ref --short HEAD`
  branch_match = branch_regex.match(branch_name)

  unless branch_match.nil?
    puts "Found: #{branch_match[0]}"
    File.open(ARGV[0], 'w') do |new_message|
      new_message.write("[#{branch_match[0]}] #{COMMIT_MESSAGE}")
    end
    exit 0
  end

  puts "[POLICY] Your commit message is not formatted correctly"
  puts "  Please include your JIRA id: '[ABC-123] Hello world!'"
  exit 1
end

check_commit_message