Skip to content

Instantly share code, notes, and snippets.

@pixelhandler
Last active July 2, 2024 11:27
Show Gist options
  • Save pixelhandler/5718585 to your computer and use it in GitHub Desktop.
Save pixelhandler/5718585 to your computer and use it in GitHub Desktop.
Git pre-push hook to prevent force pushing master branch
#!/bin/sh
# Called by "git push" after it has checked the remote status,
# but before anything has been pushed.
#
# If this script exits with a non-zero status nothing will be pushed.
#
# Steps to install, from the root directory of your repo...
# 1. Copy the file into your repo at `.git/hooks/pre-push`
# 2. Set executable permissions, run `chmod +x .git/hooks/pre-push`
# 3. Or, use `rake hooks:pre_push` to install
#
# Try a force push to master, you should get a message `*** [Policy] never force push...`
#
# The commands below will not be allowed...
# `git push --force origin master`
# `git push --delete origin master`
# `git push origin :master`
#
# Nor will a force push while on the master branch be allowed...
# `git co master`
# `git push --force origin`
#
# Requires git 1.8.2 or newer
#
# Git 1.8.2 release notes cover the new pre-push hook:
# <https://github.com/git/git/blob/master/Documentation/RelNotes/1.8.2.txt>
#
# See Sample pre-push script:
# <https://github.com/git/git/blob/87c86dd14abe8db7d00b0df5661ef8cf147a72a3/templates/hooks--pre-push.sample>
protected_branch='master'
policy='[Policy] Never force push or delete the '$protected_branch' branch! (Prevented with pre-push hook.)'
current_branch=$(git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,')
push_command=$(ps -ocommand= -p $PPID)
is_destructive='force|delete|\-f'
will_remove_protected_branch=':'$protected_branch
do_exit(){
echo $policy
exit 1
}
if [[ $push_command =~ $is_destructive ]] && [ $current_branch = $protected_branch ]; then
do_exit
fi
if [[ $push_command =~ $is_destructive ]] && [[ $push_command =~ $protected_branch ]]; then
do_exit
fi
if [[ $push_command =~ $will_remove_protected_branch ]]; then
do_exit
fi
unset do_exit
exit 0
@stefansundin
Copy link

Here's my own version of this pre-push hook, along with an install script: https://gist.github.com/stefansundin/d465f1e331fc5c632088

@stephen-mw
Copy link

It's easy to prevent pushing to multiple branches using posix regular expressions. You don't need to create and iterate through an array:

#!/bin/bash
# Prevents force-pushing to master

BRANCH=`git rev-parse --abbrev-ref HEAD`
PUSH_COMMAND=`ps -ocommand= -p $PPID`
PROTECTED_BRANCHES="^(master|dev|release-*|patch-*)"
FORCE_PUSH="force|delete|-f"

if [[ "$BRANCH" =~ $PROTECTED_BRANCHES && "$PUSH_COMMAND" =~ $FORCE_PUSH ]]; then
  echo "Prevented force-push to protected branch \"$BRANCH\" by pre-push hook"
  exit 1
fi

exit 0

@amhed
Copy link

amhed commented Jul 20, 2015

push_command=$(ps -ocommand= -p $PPID) always returns the following error for me:

ps: illegal option -- o

Im currently running bash 3.1.23 for windows

@amhed
Copy link

amhed commented Jul 20, 2015

push_command=$(ps -ocommand= -p $PPID) always returns the following error for me:

ps: illegal option -- o

Any ideas? Im currently running bash 3.1.23 for windows

@alexnewmannn
Copy link

Same issue as @amhed, googled with no luck

@agent-0007
Copy link

No windows = no problem.

@vincenzo
Copy link

@stephen-mw - love your version; I am also looking to understand how to stop any push to master, even if I am currently on a non protected branch. Let's say master is protected, but I am on my-branch. The I do git push origin master from my-branch. How would I stop that?

@lovebes
Copy link

lovebes commented Dec 16, 2015

@vincenzo, add this line. It seems to work for me.

# Prevents makes sure while you are on different branch, you don't push to master
if [ $current_branch != $protected_branch ] && [[ $push_command =~ $protected_branch ]]; then
  do_exit
fi

@luiskhernandez
Copy link

Hi, this is very useful thanks. How about if i want to prevent push to master but only in the origin remote, others remote like staging, can push force to master.

@RobertoPrevato
Copy link

RobertoPrevato commented Jun 28, 2016

It is worth mentioning that the pre-push hook is a local hook, that is a hook that is fired when invoking a command in the local repository, and is potentially editable by a user. If you want to protect your repositories against disgruntled programmers, a pre-receive hook in the remote repository is necessary. Anyway, thanks for sharing! The script is perfect when you can trust all programmers in the team.

@TxHawks
Copy link

TxHawks commented Aug 29, 2016

@luiskhernandez -

I may be a bit late for the party, but the name of the remote is passed to the hook as the first argument, so you can just put the following lines at the begining of the script:

# Exit early if pushing to a remote that isn't 'origin'
[[ $1 != "origin" ]] && exit 0

# rest of script here

@nhoag
Copy link

nhoag commented Sep 15, 2016

Over 3 years later and this is still a great script!

Note that this doesn't protect against git push --force with a Git post config as default = matching. You're covered with any other post config, and Git 2.0+ uses simple by default.

@gajendramani
Copy link

any idea in groovy as pre receieve hook.

@wojciech-kopras
Copy link

To prevent "git push --force" on a remote server it is impossible using a hook, because you cannot know the command line options given. In that case you need to set in the repository's configuration (or any level above) these options:

[receive]
        denyNonFastForwards = true
        denyDeletes = true

@dimon777
Copy link

I tried this but it doesn't show the message, and nothing is pushed to master (which is expected)

$ git push
Everything up-to-date
$ git push --force
Everything up-to-date

Why is this?

@AaronLiuIsCool
Copy link

any idea in groovy as pre receieve hook.

You can use maven or any binary build process to check-exist or install local hook.

@devinrhode2
Copy link

I don't know when this may have changed, but with git 2.32.1 and 2.33, I had to detect branch deletion like so:

STDIN=$(cat -)
[[ $STDIN =~ "(delete)" ]] && echo "deleting branch";

@devinrhode2
Copy link

$1 still maps to origin (or upstream, etc)

@milanpoudel1
Copy link

Here $1 means origin? Is it possible to get the branch name we are trying to push into ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment