Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VirtusLab/git-machete
Probably the sharpest git repository organizer & rebase/merge workflow automation tool you've ever seen
https://github.com/VirtusLab/git-machete
cli git merge rebase
Last synced: 2 months ago
JSON representation
Probably the sharpest git repository organizer & rebase/merge workflow automation tool you've ever seen
- Host: GitHub
- URL: https://github.com/VirtusLab/git-machete
- Owner: VirtusLab
- License: mit
- Created: 2018-02-24T13:32:07.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T19:07:44.000Z (3 months ago)
- Last Synced: 2024-10-29T21:21:44.698Z (3 months ago)
- Topics: cli, git, merge, rebase
- Language: Python
- Homepage:
- Size: 5.02 MB
- Stars: 910
- Watchers: 9
- Forks: 53
- Open Issues: 82
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - VirtusLab/git-machete - Probably the sharpest git repository organizer & rebase/merge workflow automation tool you've ever seen (Python)
README
# git-machete
[](https://formulae.brew.sh/formula/git-machete)
[](https://formulae.brew.sh/formula/git-machete)
[](https://pypi.org/project/git-machete)
[](https://pypistats.org/packages/git-machete)
[](https://anaconda.org/conda-forge/git-machete)
[](https://anaconda.org/conda-forge/git-machete)
[](https://snapcraft.io/git-machete)
[](https://git-machete.readthedocs.io/en/stable)
[](https://github.com/VirtusLab/git-machete/blob/master/LICENSE)
[](https://app.circleci.com/pipelines/github/VirtusLab/git-machete?branch=master)
[](https://codecov.io/gh/VirtusLab/git-machete)
[//]: # (These images are referenced by full URLs to ensure they render correctly on https://pypi.org/project/git-machete/)
[//]: # (In fact, only the light-mode image is used in PyPI, the other one is cropped out when publishing the package. Still, using the same format for consistency)
💪 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.
[//]: # (The image is referenced by its full URL to ensure it renders correctly on https://pypi.org/project/git-machete/)
🔌 See also [VirtusLab/git-machete-intellij-plugin](https://github.com/VirtusLab/git-machete-intellij-plugin#git-machete-intellij-plugin) —
a port into a plugin for the IntelliJ Platform products, including PyCharm, WebStorm etc.
## Install
We provide a couple of alternative ways of installation. See [PACKAGES.md](PACKAGES.md) for the full list.
git-machete requires Python >= 3.6. Python 2.x is no longer supported.
### Using Homebrew (macOS & most Linux distributions)
```shell script
brew install git-machete
```
### Using pip
You need to have Python and `pip` installed from system packages.
**For user-wide install:**
```shell script
pip install --user git-machete
```
Please verify that your `PATH` variable has `${HOME}/.local/bin/` included.
**For system-wide install:**
```shell script
sudo -H pip install git-machete # system-wide install
```
**Tip:** pass an extra `-U` flag to `pip install` to upgrade an already installed version.
### Using conda
```shell script
conda install -c conda-forge git-machete
```
### Using Scoop (Windows)
```shell script
scoop install git-machete
```
### Using snap (most Linux distributions)
**Tip:** check the [guide on installing snapd](https://snapcraft.io/docs/installing-snapd) if you don't have Snap support set up yet in your system.
```shell script
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 apt-get via PPA (Ubuntu)
**Tip:** run `sudo apt-get install -y software-properties-common` first if `add-apt-repository` is not available on your system.
```shell script
sudo add-apt-repository ppa:virtuslab/git-machete
sudo apt-get update
sudo apt-get install -y python3-git-machete
```
### Using Alpine, Arch, Gentoo & other Linux distro-specific package managers
Check [Repology](https://repology.org/project/git-machete/versions) for the available distro-specific packages.
### Using Nix (macOS & most Linux distributions)
On macOS and most Linux distributions, you can install via [Nix](https://nixos.org/nix):
```shell script
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](https://repology.org/project/git-machete/versions) for the current channel-package mapping.
### Using Pex
The [Pex tool](https://github.com/pex-tool/pex) (short for Python EXecutable) allows you to build "pex" files which are executable Python environments in a single file.
Assuming you have already installed the `pex` utility, you can build git-machete as a pex:
```shell_script
pex git-machete -m git_machete.bin:main -o git-machete
```
Then put the produced `git-machete` file somewhere on your `PATH`.
## Quick start
### Discover the branch layout
```shell script
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
```shell script
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
```shell script
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
```shell script
git machete advance
```
Useful for merging the child branch to the current branch in a linear fashion (without creating a merge commit).
### GitHub & GitLab 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:
```shell script
git machete github checkout-prs [--all | --by= | --mine | ... ]
git machete gitlab checkout-mrs [--all | --by= | --mine | ... ]
```
Create the PR/MR, using the upstream (parent) branch from `.git/machete` as the base:
```shell script
git machete github create-pr [--draft]
git machete gitlab create-mr [--draft]
```
The entire chain of PRs/MRs will be posted in the PR/MR description (example for GitHub):
[//]: # (The image is referenced by its full URL to ensure it renders correctly on https://pypi.org/project/git-machete/)
**Note**: for private repositories (or side-effecting operations like `create-pr`/`create-mr` on public repositories),
a GitHub API token with `repo` access or a GitLab API token with `api` access is required.
See the docs for [`github`](https://git-machete.readthedocs.io/#github)
or [`gitlab`](https://git-machete.readthedocs.io/#gitlab) for how to provide the token.
### Shell completions
When git-machete is installed via **Homebrew** (and a few other supported package managers, see [PACKAGES.md](PACKAGES.md)),
shell completions should be installed automatically.
For other package managers (like **pip**), or when your shell doesn't pick up the Homebrew-installed completion, use the following:
#### Bash
Put the following into `~/.bashrc` or `~/.bash_profile`:
```shell script
eval "$(git machete completion bash)" # or, if it doesn't work:
source <(git machete completion bash)
```
#### Fish
Put the following into `~/.config/fish/config.fish`:
```shell script
git machete completion fish | source
```
#### Zsh
Put the following into `~/.zshrc`:
```shell script
eval "$(git machete completion zsh)" # or, if it doesn't work:
source <(git machete completion zsh)
```
## 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?
[//]: # (For how to find Medium header anchors, see https://www.freecodecamp.org/news/how-to-link-to-a-specific-paragraph-in-your-medium-article-2018-table-of-contents-method-e66595fea549/)
No! It's all right, `discover` is based on an (imperfect)
[heuristic](https://medium.com/virtuslab/git-machete-strikes-again-traverse-the-git-rebase-jungle-even-faster-with-v2-0-f43ebaf8abb0#0544)
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`](https://git-machete.readthedocs.io/en/stable/#edit) to fix the layout manually.
If you're working on JetBrains IDEs, you can use [git-machete IntelliJ plugin](https://github.com/VirtusLab/git-machete-intellij-plugin#git-machete-intellij-plugin)
to have branch name completion when editing `.git/machete` file.
Also, consider [`git machete github checkout-prs` or `git machete gitlab checkout-mrs`](#github--gitlab-integration)
instead of `git machete discover` if you already have GitHub PRs/GitLab MRs 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`](https://git-machete.readthedocs.io/en/stable/#traverse)),
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-pick`s 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](https://slides.com/plipski/git-machete/#/11).
#### 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"](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell).
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_](https://medium.com/virtuslab/make-your-way-through-the-git-rebase-jungle-with-git-machete-e2ed4dbacd02#1ac9)
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](https://virtuslab.github.io/tips/#git/git-reflog)) 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...`](https://git-machete.readthedocs.io/#fork-point) command.
## Reference
Find the docs at [Read the Docs](https://git-machete.readthedocs.io/).
You can also check `git machete help` and `git machete help `.
For the excellent overview for the reasons to use small & stacked PRs,
see [Ben Congdon](https://github.com/bcongdon)'s [blog post](https://benjamincongdon.me/blog/2022/07/17/In-Praise-of-Stacked-PRs/).
Take a look at git-machete
[reference blog post](https://medium.com/virtuslab/make-your-way-through-the-git-rebase-jungle-with-git-machete-e2ed4dbacd02)
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](https://medium.com/virtuslab/git-machete-strikes-again-traverse-the-git-rebase-jungle-even-faster-with-v2-0-f43ebaf8abb0).
## Git compatibility
git-machete (since version 2.13.0) is compatible with git >= 1.8.0.
## Contributions
Contributions are welcome! See [contributing guidelines](CONTRIBUTING.md) for details.