Recently I wondered how to improve my workflow with Git. I came across the Web and found some article which pointed on Git hooks that were introduced since version 1.8.2.This cool feature allows you to execute some code before (or after) some actions made in Git.
My team and I have decided, that we will complete our tasks in "feature branches" (that is the de-facto standard workflow in Git), and to do it so, we've marked our main branches: master, stage and develop as
protected once. That means, only users with master access or greater (for the repository), can push directly to this branches. I've got that privilege but switching between many branches, fetching, pulling, pushing, fetching, pulling - those all actions may confuse a mind for a few seconds.Then I realize if there's any available option to warning important actions (like push force to master) on those protected branches. Few minutes of searching and puff... Git hooks came in on the stage.
Guardian script
With some examples on the web and also with Git documentation, I wrote a simple Git pre-push script which checks in which branch you are currently in and it will ask you "Are you intend to push?" to those protected branches.The full script is available below:
sh
#!/bin/bash
# General colors
black='\x1B[0;30m'
red='\x1B[0;31m'
green='\x1B[0;32m' # '\e[1;32m' is too bright for white bg.
blue='\x1B[1;34m'
yellow='\x1B[0;33m'
purple='\x1B[1;35m'
cyan='\x1B[0;36m'
endColor='\x1B[0m'
protected_branches=( master stage develop )
current_branch=$(git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,')
for i in "${protected_branches[@]}"
do
if [ ${i} == ${current_branch} ]; then
echo -en "${yellow}[Git pre-push]${endColor} You're about to push to ${red}${i}${endColor}, is that what you intended?"
read -p " [y/N] " -r < /dev/tty
if echo ${REPLY} | egrep -E '^[yY]$' > /dev/null
then
echo -e "Continue of pushing to ${red}${i}${endColor}"
exit 0 # push will execute
fi
echo -en "Abort pushing to ${red}${i}${endColor}\n"
exit 1 # push will not execute
fi
done
exit 0 # push will execute when won't match protected_branches
Question that only works when confirming with return key (this is the time to think about if you want to perform this action)
Default value of question set to No
Message of committed action
Things which may be improved in future:
Download list of protected branches direct from repository
Add support for some popular flags like: --force
How to use it?
You need to copy this into your git project. There you should have a .git/hooks directory (if not you have probably your Git older then v1.8.2). Then save above file as .git/hooks/pre-push.
Now every time you'll push to one of your protected_branches listed inside the file, Git will ask you if that was your intended action. For every Git masters, this little trick can save a day ;)
Don't forget to add executive permissions to this file with chmod +x pre-push.