Class: Overcommit::Hook::CommitMsg::GerritChangeId

Inherits:
Base
  • Object
show all
Defined in:
lib/overcommit/hook/commit_msg/gerrit_change_id.rb

Overview

Ensures a Gerrit Change-Id line is included in the commit message.

It may seem odd to do this here instead of in a prepare-commit-msg hook, but the reality is that if you want to ensure the Change-Id is included then you need to do it in a commit-msg hook. This is because the user could still edit the message after a prepare-commit-msg hook was run.

See Also:

Constant Summary collapse

SCRIPT_LOCATION = 
Overcommit::Utils.script_path('gerrit-change-id')

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#applicable_files, #command, #description, #enabled?, #excluded?, #execute, #execute_in_background, #flags, #in_path?, #included_files, #initialize, #name, #parallelize?, #processors, #quiet?, #required?, #required_executable, #required_libraries, #run?, #run_and_transform, #skip?

Constructor Details

This class inherits a constructor from Overcommit::Hook::Base

Instance Method Details

#run ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/overcommit/hook/commit_msg/gerrit_change_id.rb', line 15

def run
  result = execute(['sh', SCRIPT_LOCATION, commit_message_file])
  return :pass if result.success?

  [:fail, result.stdout]
end