This repo contains some Git utility scripts. The highlights are
git push-branch, and
git undo, which you'll never understand how you did without.
The commands are especially useful when combined with pivotal-github gem (which, despite its name, also works with Bitbucket).
git-utils used to be pure Bash scripts, but they are now available as a Ruby gem, both because Ruby is more powerful than bash and because now
git-utils can be included more easily as a dependency for the pivotal-github gem. As a result, installation is easy if you have RubyGems installed:
gem install git-utils
git amend: alias for
git commit --amend
git bump: makes a commit with the message "Bump version number"
git cleanup: deletes every branch already merged into current branch (apart from
development, and any branches listed in
~/.git-cleanup-preserved). Pass the
-roption to delete remote merged branches.
git merge-into-branch [branch]: merges current branch into given branch (defaults to
git minor: makes a commit with the message "Make minor changes"
git open: opens the remote page for the repo (OS X & Linux)
git polish: makes a commit with the message "Polish"
git pull-request: pushes the branch and opens the remote page for issuing a new a pull request (OS X only)
git push-branch: pushes the current branch up to origin
git delete-remote-branch <branch>: deletes the remote branch if it is safe to do so
git switch <pattern>: switches to the first branch matching the given pattern
git sync [branch]: syncs the given branch with the remote branch (defaults to master)
git typo: makes a commit with the message "Fix typo"
git undo: undoes the last commit
git graph: displays full repository history in graphical format; alias for
git log --graph --oneline --decorate --all --full-history --author-date-order --no-notes
Here are some suggested aliases:
git config --global alias.mib merge-into-branch git config --global alias.pr pull-request git config --global alias.pb push-branch
Some of these commands deserve further explanation.
git merge-into-branch [target] merges the current branch into the target branch (defaults to
master). On a branch called
git merge-into-branch is equivalent to the following:
$ git checkout master $ git merge --no-ff --log add-markdown-support
Note that this effectively changes the default merge behavior from fast-forward to no-fast-forward, which makes it possible to use
git log to see which of the commit objects together have implemented a feature on a particular branch. As noted in A successful Git branching model,
--no-ffflag causes the merge to always create a new commit object, even if the merge could be performed with a fast-forward. This avoids losing information about the historical existence of a feature branch and groups together all commits that together added the feature… Yes, it will create a few more (empty) commit objects, but the gain is much bigger than that cost.
In addition, the
--log option puts the commit messages from the individual commits in the merge message, which is especially useful for viewing the full diff represented by the commit.
These options can be overriden (and thus restored to their defaults) by passing the options
git merge-into-branch accepts any options valid for
git push-branch creates a remote branch at
origin with the name of the current branch:
$ git push-branch * [new branch] add-markdown-support -> add-markdown-support
git push-branch accepts any options valid for
git sync [branch] syncs the given local branch with the remote branch (defaults to master). On a branch called
git sync is equivalent to the following:
$ git checkout master $ git pull $ git checkout add-markdown-support
The main purpose of
git sync is to prepare the current branch for merging with
$ git sync $ git merge master
(This is essentially equivalent to
$ git fetch $ git merge origin/master
but I don't like having
origin/master be different since that means you have to remember to run
git pull on
master some time down the line.)
gem install git-utils