singhdx / git-common-utils

Opinionated tools for managing a team based git workflow

git-workflow

Opinionated tools for managing a team based git workflow.

Principles

• Local master is kept clean and relatively up to date with origin
• Avoid merge commits where possible
• Most work occurs in personal branches and are considered private (hence push -f is acceptable)

Prequisites

Have Python 2.7 or Python 3.6.

Install requirements:

pip install -r requirements.txt

Add this folder to your path, so git can pick up the scripts.

Commands

Start

Pulls master and creates a new feature branch named $USERNAME/feature.

git start [feature]

Switch

Switches between feature branches.

git switch [feature]

If the feature branch named $USERNAME/feature isn't found, the command tries out the name verbatim. This means it can also be used with non-feature branches (such as master).

Sync

Pulls master and rebases working branch.

git sync [-i]

This is useful to avoid your changes being interleaved with other commits. For example, say you were coding in your branch and made the changes A, B, C. If you merge with master the commit history may now be W, A, X, Y, B, Z, C. Leaving the history like this can make it harder to rollback a logical set of changes in one go. Using rebase, you will replay your commits on the end of master, resulting in W, X, Y, Z, A, B, C.

Often it makes sense to make a lot of changes locally, that you wouldn't necessarily want to push together, in cases like this you can use git sync -i to interactively rebase your changes and squash some commits. This can result in a commit history showing W, X, Y, Z, D.

Much cleaner, right? But do be careful that you understand what is going on as rebase can both squash and remove commits.

Sync All

Pulls master and rebases all local branches.

git sync-all

Pull Request

Opens a GitHub pull request for the current branch

git pull-request

Reviewer Aliases

If you frequently request review from the same handful of people, reviewer aliases can reduce the amount to have to type/remember.

Add aliases with the git config CLI:

$ git config gitworkflow.alias.alice alice_has_a_long_git_handle
$ git config gitworkflow.alias.bob hard2remember31415
$ git config gitworkflow.alias.$ALIAS $GITHUB_HANDLE

When git-workflow asks you to specify reviewers, if you enter alice, the PR will be sent to alice_has_a_long_git_handle.

Cleanup

Removes local and remote branches that have been merged into master.

git cleanup

GitHub Login

Requests GitHub credentials to be used by other scripts

git github-login

Prompts for GitHub username/password and optional OTP password, then requests a github auth token. Credentials are stored in ~/.github-auth.

License

Licensed under the Apache License, Version 2.0.