git absorb
This is a port of Facebook's hg absorb
, which I first read about on mozilla.dev.version-control.
Elevator Pitch
You have a feature branch with a few commits. Your teammate reviewed the branch and pointed out a few bugs. You have fixes for the bugs, but you don't want to shove them all into an opaque commit that says fixes
, because you believe in atomic commits. Instead of manually finding commit SHAs for git commit --fixup
, or running a manual interactive rebase, do this:
git add $FILES_YOU_FIXED
git absorb
git rebase -i --autosquash master
git absorb
will automatically identify which commits are safe to modify, and which indexed changes belong to each of those commits. It will then write fixup!
commits for each of those changes. You can check its output manually if you don't trust it, and then fold the fixups into your feature branch with git's built-in autosquash functionality.
Installing
You will need the following:
- cargo
- CMake
- libgit2 optional dependencies
Then cargo install git-absorb
. Make sure that $CARGO_HOME/bin
is on your $PATH
so that git can find the command. ($CARGO_HOME
defaults to ~/.cargo
.)
Note that git absorb
does not use the system libgit2. This means you do not need to have libgit2 installed to build or run it. However, this does mean you have to be able to build libgit2, hence the build-time dependency on CMake.
Usage
git add
any changes that you want to absorb. By design,git absorb
will only consider content in the git index.git absorb
. This will create a sequence of commits onHEAD
. Each commit will have afixup!
message indicating the SHA of the commit it should be squashed into.- If you are satisfied with the output,
git rebase -i --autosquash
to squash thefixup!
commits into their predecessors. You can set theGIT_SEQUENCE_EDITOR
environment variable if you don't need to edit the rebase TODO file. - If you are not satisfied (or if something bad happened),
git reset --soft
to the pre-absorption commit to recover your old state. (You can find the commit in question withgit reflog
.) And if you thinkgit absorb
is at fault, please file an issue.
TODO
- implement force flag
- implement remote default branch check
- add flag to automatically run rebase after successful absorption
- add smaller force flags to disable individual safety checks
- stop using
failure::err_msg
and ensure all error output is actionable by the user - slightly more log output in the success case
- more tests (esp main module and integration tests)
- travis
- windows support and appveyor
- document stack and commute details
- more commutation cases (esp copy/rename detection)
- don't load all hunks in memory simultaneously because they could be huge
- implement some kind of index locking to protect against concurrent modifications