Use Git hooks to automatically push after every commit
A Git hook is a shell script that is invoked at specific points during some Git operations. They are documented in the Git book.
The hook we are interested in is post-commit (documented
here). It gets run after a new commit is made. This is exactly when
we want to try and update our remote.
Our hook will:
- Execute each time you commit something into your repository.
- Avoid doing anything if the commit is made during a rebase or merge.
- Push to a remote named
origin(or whichever one you change theUPSTREAMshell variable to point). - Create or update a remote reference that matches the branch name that’s currently checked out.
Copy and paste the following script into a file named
.git/hooks/post-commit in your repository directory.
IMPORTANT: Afterwards make the script runnable via
chmod +x .git/hooks/post-commit.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| #!/usr/bin/env bash | |
| # From: https://gist.github.com/asankah/a6263bbd6081bffd031ca066e5177df2 | |
| # This script is executed from the GIT_DIR in a bare repository or at the root | |
| # of the work tree. | |
| git_dir=$( git rev-parse --git-dir ) | |
| if [[ -d "${git_dir}/rebase-apply" || -d "${git_dir}/rebase-merge" ]]; then | |
| # We are in the middle of a merge or rebase. Wait until that's done. The final | |
| # commit -- if any -- would re-invoke this script. | |
| exit 0 | |
| fi | |
| # Stop the script if something goes wrong instead of continuing past an error. | |
| set -e | |
| # head_commit is the most recent commit. | |
| head_commit=$( git rev-parse HEAD ) | |
| full_branch=$( git symbolic-ref HEAD 2> /dev/null || echo "" ) | |
| # Detached head. | |
| if [[ -z ${full_branch} ]]; then | |
| exit 0 | |
| fi | |
| branch_name=$( basename ${full_branch} ) | |
| # If there is no upstream remote specified, then skip autopush. There are other | |
| # kinds of upstreams that a branch can push to (see git-push(1)), but those are | |
| # not supported for the moment. | |
| upstream=$( git config branch.${branch_name}.remote 2> /dev/null || echo "" ) | |
| if [[ -z ${upstream} ]]; then | |
| exit 0 | |
| fi | |
| # Push. Add a `--force-with-lease` if you are prone to rewriting your history. | |
| # We've already verified that the branch has an upstream remote. git-push will | |
| # pick that up by default along with the default refspec. No need to override | |
| # either of those. | |
| git push --force-with-lease |
Last modified: July 5, 2022