Skip to main content

Probably the sharpest git repository organizer & rebase/merge workflow automation tool you've ever seen

Project description

git-machete

homebrew formula homebrew formula monthly downloads PyPI package PyPI package monthly downloads Conda package Conda downloads Snap
Read the Docs License: MIT CircleCI codecov

💪 git-machete is a robust tool that simplifies your git workflows.

🦅 The bird's eye view provided by git-machete makes merges/rebases/push/pulls hassle-free even when multiple branches are present in the repository (master/develop, your topic branches, teammate's branches checked out for review, etc.).

🎯 Using this tool, you can maintain small, focused, easy-to-review pull requests with little effort.

👁 A look at a git machete status gives an instant answer to the questions:

  • What branches are in this repository?
  • What is going to be merged (rebased/pushed/pulled) and to what?

🚜 git machete traverse semi-automatically traverses the branches, helping you effortlessly rebase, merge, push and pull.

git machete discover, status and traverse

🔌 See also VirtusLab/git-machete-intellij-plugin — a port into a plugin for the IntelliJ Platform products, including PyCharm, WebStorm etc.

Install

We suggest a couple of alternative ways of installation.

Instructions for installing bash, zsh, and fish completion scripts are provided in completion/README.md.

git-machete requires Python >= 3.6. Python 2.x is no longer supported.

Using Homebrew (macOS)

brew install git-machete

Using Snappy (most Linux distributions)

Tip: check the guide on installing snapd if you don't have Snap support set up yet in your system.

sudo snap install --classic git-machete

It can also be installed via Ubuntu Software (simply search for git-machete).

Note: classic confinement is necessary to ensure access to the editor installed in the system (to edit e.g. .git/machete file or rebase TODO list).

Using PPA (Ubuntu)

Tip: run sudo apt-get install -y software-properties-common first if add-apt-repository is not available on your system.

sudo add-apt-repository ppa:virtuslab/git-machete
sudo apt-get update
sudo apt-get install -y python3-git-machete

Using rpm (Fedora/RHEL/CentOS/openSUSE...)

Download the rpm package from the latest release and install either by opening it in your desktop environment or with rpm -i git-machete-*.noarch.rpm.

Using AUR (Arch Linux)

Install the AUR package git-machete using an AUR helper of your preference.

Using Nix (macOS & most Linux distributions)

On macOS and most Linux distributions, you can install via Nix:

nix-channel --add https://nixos.org/channels/nixos-unstable unstable  # if you haven't set up any channels yet
nix-env -i git-machete

Note: since nixos-21.05, git-machete is included in the stable channels as well. The latest released version, however, is generally available in the unstable channel. Stable channels may lag behind; see repology for the current channel-package mapping.

Using pip with sudo (system-wide install)

You need to have Python and pip installed from system packages.

sudo -H pip install git-machete

Tip: pass an extra -U flag to pip install to upgrade an already installed version.

Using pip without sudo (user-wide install)

You need to have Python and pip installed from system packages.

pip install --user git-machete

Please verify that your PATH variable has ${HOME}/.local/bin/ included.

Tip: pass an extra -U flag to pip install to upgrade an already installed version.

Using conda

conda install -c conda-forge git-machete

Quick start

Discover the branch layout

cd your-repo/
git machete discover

See and possibly edit the suggested layout of branches. Branch layout is always kept as a .git/machete text file, which can be edited directly or via git machete edit.

See the current repository state

git machete status --list-commits

Green edge means the given branch is in sync with its parent.
Red edge means it is out of sync — parent has some commits that the given branch does not have.
Gray edge means that the branch is merged to its parent.

Rebase, reset to remote, push, pull all branches as needed

git machete traverse --fetch --start-from=first-root

Put each branch one by one in sync with its parent and remote tracking branch.

Fast-forward merge a child branch into the current branch

git machete advance

Useful for merging the child branch to the current branch in a linear fashion (without creating a merge commit).

GitHub integration

Check out the given PRs into local branches, also traverse chain of pull requests upwards, adding branches one by one to git-machete and check them out locally as well:

git machete github checkout-prs [--all | --by=<github-login> | --mine | <PR-number-1> ... <PR-number-N>]

Create the PR, using the upstream (parent) branch from .git/machete as the base:

git machete github create-pr [--draft]

Note: for private repositories, a GitHub API token with repo access is required. This will be resolved from the first of:

  1. The GITHUB_TOKEN env var.
  2. The content of the .github-token file in the home directory (~). This file has to be manually created by the user.
  3. The auth token from the current gh configuration.
  4. The auth token from the current hub configuration.

FAQ

I've run git machete discover... but the branch layout I see in .git/machete doesn't exactly match what I expected. Am I doing something wrong?

No! It's all right, discover is based on an (imperfect) heuristic which usually yields branch layout close to what the user would expect. It still might not be perfect and — for example — declare branches to be children of main/develop instead of each other.

Just run git machete edit to fix the layout manually. If you're working on JetBrains IDEs, you can use git-machete IntelliJ plugin to have branch name completion when editing .git/machete file.

Also, consider git machete github checkout-prs instead of git machete discover if you already have GitHub PRs opened.


Can I use git merge for dealing with stacked PRs?

There are two commonly used ways to put a branch back in sync with its base (parent) branch:

  1. rebase the branch onto its base branch
  2. merge the base branch into the branch

While git-machete supports merging base branch (like main) to update the branch (git machete traverse --merge), this approach works poorly with stacked PRs. You might end up with a very tangled history very quickly, and a non-trivial sequence of git cherry-picks might be needed to restore order.

That is why we recommend using rebase over merge for stacked PRs. However, we still recommend using merge for the narrow case of backporting hotfixes.


Sometimes when I run update or traverse, too many commits are taken into the rebase... how to fix that?

Contrary to the popular misconception, git doesn't have a notion of "commits belonging to a branch". A branch is just a movable reference to a commit.

This makes it hard in general case to determine the range of commits that form the "unique history" of the given branch. There's an entire algorithm in git-machete for determining the fork point of the branch (i.e. the place after which the unique history of the branch starts).

One thing that you can do to help fork-point algorithm in its job, is to not delete local branches instantly after they're merged or discarded. They (or specifically, their reflogs) will be still useful for a while to determine fork points for other branches (and thus, the range of commits taken into rebase).

Also, you can always override fork point for a branch explicitly with git machete fork-point --override-to... command.


Reference

Find the docs at Read the Docs. You can also check git machete help and git machete help <command>.

For the excellent overview for the reasons to use small & stacked PRs, see Ben Congdon's blog post.

Take a look at git-machete reference blog post for a guide on how to use the tool.

The more advanced features like automated traversal, upstream inference and tree discovery are described in the second part of the series.


Git compatibility

git-machete (since version 2.13.0) is compatible with git >= 1.8.0.


Contributions

Contributions are welcome! See contributing guidelines for details. Help would be especially appreciated with Python code style, refactoring and tests — so far more focus has been put on features, documentation and automating the distribution.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git-machete-3.13.0.tar.gz (92.7 kB view hashes)

Uploaded source

Built Distribution

git_machete-3.13.0-py2.py3-none-any.whl (80.2 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page