git-sync

#!/usr/bin/env python
#
# git-sync
#
# Script for syncing the main branch with origin and rebasing changes in the
# current branch on top of the new main.
#
# Usage:
# $ git sync [-i]
#
# Is equivalent to calling:
#   main=$(git symbolic-ref refs/remotes/origin/HEAD | sed 's@^refs/remotes/origin/@@')
#   git checkout $main
#   git pull origin $main
#   git checkout feature-branch
#   git rebase $main feature-branch [-i]
#
# Reasonable efforts are taken to handle errors and make sure you end off back
# on your initial branch.

import sys
import os
import git
import util

if len(sys.argv) > 2:
    util.fatal('Incorrect usage, missing branch name. Use: git sync [-i]')

interactive = False
if len(sys.argv) > 1:
    if sys.argv[1] == '-i':
        interactive = True
    else:
        util.fatal('Incorrect usage, unexpected argument to git sync: "%s"' % sys.argv[1])

try:
    repo = git.Repo(os.getcwd(), search_parent_directories=True)
except git.exc.InvalidGitRepositoryError:
    util.fatal('git sync must be run from within a valid git repository.')

util.fatal_if_dirty(repo)

initial_branch = repo.active_branch

util.update_main(repo, initial_branch)

main = util.main_branch_name(repo)
util.info('Rebasing %s on %s' % (initial_branch, main))
initial_branch.checkout()

if interactive:
    repo.git.rebase(main, '-i')
else:
    repo.git.rebase(main)

util.success('%s synced with origin, %s rebased' % (main, initial_branch))