Commit c2fe6c70 authored by Peter van der Does's avatar Peter van der Does Committed by Vincent Driessen

Add some documentation to the do_hook function

Signed-off-by: 's avatarPeter van der Does <peter@avirtualhome.com>
Signed-off-by: 's avatarVincent Driessen <vincent@3rdcloud.com>
parent 56ec32c1
...@@ -324,6 +324,22 @@ require_branches_equal() { ...@@ -324,6 +324,22 @@ require_branches_equal() {
fi fi
} }
#
# do_hook
# Inputs:
# $1 = prefix of the hook
# Currently the following prefixes are supported
# pre - Executed before the command is executed
# post - Executed after the command is successfully executed.
#
# The hook called should be executable.
# The hooks should return an exit code 0 on success. Any other return code will result in aborting the git flow process.
#
# Naming convention of a hook:
# <prefix>_<SUB COMMAND>_<SUB ACTION>
# Example for a hook called before the command git flow feature start test is executed:
# pre_feature_start
#
do_hook() { do_hook() {
local prefix="$1" local prefix="$1"
local return_code=0 local return_code=0
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment