Although Git is a very powerful tool, I think most people would agree when I say it can also be... a total nightmare π I've always found it very useful to visualize in my head what's happening when working with Git: how are the branches interacting when I perform a certain command, and how will it affect the history? Why did my coworker cry when I did a hard reset on master
, force push
ed to origin and rimraf
'd the .git
folder?
I thought it would be the perfect use case to create some visualized examples of the most common and useful commands! π₯³ Many of the commands I'm covering have optional arguments that you can use in order to change their behavior. In my examples, I'll cover the default behavior of the commands without adding (too many) config options! π
Merging
Having multiple branches is extremely convenient to keep new changes separated from each other, and to make sure you don't accidentally push unapproved or broken changes to production. Once the changes have been approved, we want to get these changes in our production branch!
One way to get the changes from one branch to another is by performing a git merge
! There are two types of merges Git can perform: a fast-forward, or a no-fast-forward π’
This may not make a lot of sense right now, so let's look at the differences!
Fast-forward (--ff
)
A fast-forward merge can happen when the current branch has no extra commits compared to the branch weβre merging. Git is... lazy and will first try to perform the easiest option: the fast-forward! This type of merge doesnβt create a new commit, but rather merges the commit(s) on the branch weβre merging right in the current branch π₯³
Perfect! We now have all the changes that were made on the dev
branch available on the master
branch. So, what's the no-fast-forward all about?
No-fast-foward (--no-ff
)
It's great if your current branch doesn't have any extra commits compared to the branch that you want to merge, but unfortunately that's rarely the case! If we committed changes on the current branch that the branch we want to merge doesn't have, git will perform a no-fast-forward merge.
With a no-fast-forward merge, Git creates a new merging commit on the active branch. The commit's parent commits point to both the active branch and the branch that we want to merge!
No big deal, a perfect merge! π The master
branch now contains all the changes that we've made on the dev
branch.
Merge Conflicts
Although Git is good at deciding how to merge branches and add changes to files, it cannot always make this decision all by itself π This can happen when the two branches we're trying to merge have changes on the same line in the same file, or if one branch deleted a file that another branch modified, and so on.
In that case, Git will ask you to help decide which of the two options we want to keep! Let's say that on both branches, we edited the first line in the README.md
.
If we want to merge dev
into master
, this will end up in a merge conflict: would you like the title to be Hello!
or Hey!
?
When trying to merge the branches, Git will show you where the conflict happens. We can manually remove the changes we don't want to keep, save the changes, add the changed file again, and commit the changes π₯³
Yay! Although merge conflicts are often quite annoying, it makes total sense: Git shouldn't just assume which change we want to keep.
Rebasing
We just saw how we could apply changes from one branch to another by performing a git merge
. Another way of adding changes from one branch to another is by performing a git rebase
.
A git rebase
copies the commits from the current branch, and puts these copied commits on top of the specified branch.
Perfect, we now have all the changes that were made on the master
branch available on the dev
branch! π
A big difference compared to merging, is that Git won't try to find out which files to keep and not keep. The branch that we're rebasing always has the latest changes that we want to keep! You won't run into any merging conflicts this way, and keeps a nice linear Git history.
This example shows rebasing on the master
branch. In bigger projects, however, you usually don't want to do that. A git rebase
changes the history of the project as new hashes are created for the copied commits!
Rebasing is great whenever you're working on a feature branch, and the master branch has been updated. You can get all the updates on your branch, which would prevent future merging conflicts! π
Interactive Rebase
Before rebasing the commits, we can modify them! π We can do so with an interactive rebase. An interactive rebase can also be useful on the branch you're currently working on, and want to modify some commits.
There are 6 actions we can perform on the commits we're rebasing:
-
reword
: Change the commit message -
edit
: Amend this commit -
squash
: Meld commit into the previous commit -
fixup
: Meld commit into the previous commit, without keeping the commit's log message -
exec
: Run a command on each commit we want to rebase -
drop
: Remove the commit
Awesome! This way, we can have full control over our commits. If we want to remove a commit, we can just drop
it.
Or if we want to squash multiple commits together to get a cleaner history, no problem!
Interactive rebasing gives you a lot of control over the commits you're trying to rebase, even on the current active branch!
Resetting
It can happen that we committed changes that we didn't want later on. Maybe it's a WIP
commit, or maybe a commit that introduced bugs! π In that case, we can perform a git reset
.
A git reset
gets rid of all the current staged files and gives us control over where HEAD
should point to.
Soft reset
A soft reset moves HEAD
to the specified commit (or the index of the commit compared to HEAD
), without getting rid of the changes that were introduced on the commits afterward!
Let's say that we don't want to keep the commit 9e78i
which added a style.css
file, and we also don't want to keep the commit 035cc
which added an index.js
file. However, we do want to keep the newly added style.css
and index.js
file! A perfect use case for a soft reset.
When typing git status
, you'll see that we still have access to all the changes that were made on the previous commits. This is great, as this means that we can fix the contents of these files and commit them again later on!
Hard reset
Sometimes, we don't want to keep the changes that were introduced by certain commits. Unlike a soft reset, we shouldn't need to have access to them any more. Git should simply reset its state back to where it was on the specified commit: this even includes the changes in your working directory and staged files! π£
Git has discarded the changes that were introduced on 9e78i
and 035cc
, and reset its state to where it was on commit ec5be
.
Reverting
Another way of undoing changes is by performing a git revert
. By reverting a certain commit, we create a new commit that contains the reverted changes!
Let's say that ec5be
added an index.js
file. Later on, we actually realize we didn't want this change introduced by this commit anymore! Let's revert the ec5be
commit.
Perfect! Commit 9e78i
reverted the changes that were introduced by the ec5be
commit. Performing a git revert
is very useful in order to undo a certain commit, without modifying the history of the branch.
Cherry-picking
When a certain branch contains a commit that introduced changes we need on our active branch, we can cherry-pick
that command! By cherry-pick
ing a commit, we create a new commit on our active branch that contains the changes that were introduced by the cherry-pick
ed commit.
Say that commit 76d12
on the dev
branch added a change to the index.js
file that we want in our master
branch. We don't want the entire we just care about this one single commit!
Cool, the master branch now contains the changes that 76d12
introduced!
Fetching
If we have a remote Git branch, for example a branch on Github, it can happen that the remote branch has commits that the current branch doesn't have! Maybe another branch got merged, your colleague pushed a quick fix, and so on.
We can get these changes locally, by performing a git fetch
on the remote branch! It doesn't affect your local branch in any way: a fetch
simply downloads new data.
We can now see all the changes that have been made since we last pushed! We can decide what we want to do with the new data now that we have it locally.
Pulling
Although a git fetch
is very useful in order to get the remote information of a branch, we can also perform a git pull
. A git pull
is actually two commands in one: a git fetch
, and a git merge
. When we're pulling changes from the origin, we're first fetching all the data like we did with a git fetch
, after which the latest changes are automatically merged into the local branch.
Awesome, we're now perfectly in sync with the remote branch and have all the latest changes! π€©
Reflog
Everyone makes mistakes, and that's totally okay! Sometimes it may feel like you've screwed up your git repo so badly that you just want to delete it entirely.
git reflog
is a very useful command in order to show a log of all the actions that have been taken! This includes merges, resets, reverts: basically any alteration to your branch.
If you made a mistake, you can easily redo this by resetting HEAD
based on the information that reflog
gives us!
Say that we actually didn't want to merge the origin branch. When we execute the git reflog
command, we see that the state of the repo before the merge is at HEAD@{1}
. Let's perform a git reset
to point HEAD back to where it was on HEAD@{1}
!
We can see that the latest action has been pushed to the reflog
!
Git has so many useful porcelain and plumbing commands, I wish I could cover them all! π I know there are many other commands or alterations that I didn't have time for to cover right now - let me know what your favorite/most useful commands are, and I may cover them in another post!
And as always, feel free to reach out to me! π
Top comments (95)
Awesome visualizations as usual!
It's interesting there's a few different syntaxes for selecting a previous commit:
Good idea to add that! I'm thinking of generally creating a "cheatsheet" format that also covers all that stuff :) Will do in the next one or when I update the format π
Came here to comment specifically along these lines - I can never ever remember what the difference between
HEAD~2
andHEAD^2
is !Had completely forgotten about
HEAD@{n}
syntax :DNice visualizations! What do you use to create them?
I'd love to know the answer to that too! :)
Lydia answered in another post of hers, which I recommend myself, that she used Keynote (the presentation software by Apple) to make the animations and then screen-recorded the slides.
The Post is "JavaScript Visualized: the JavaScript Engine"
Lol! Her profile description has the asnwer. :P
Thanks for clearing that up
Awesome animations. It is great to see a diagrammatic representation of these git commands.
For "git pull", is the animation correct? I would have expected it to fetch the commits and then do a ff merge.
For clarity, it would also help to distinguish between the remote repository and the local remote branches in the animations.
I also expected the ff merge. But now she already has an animation for
git pull --no-ff
if ever she needs one. πAmazing article Lydia!
I prefer to use Git in terminal as opposed to a GUI like the others on my team so I can face my Git fears. However, most of the documentation I read online is very complicated. Yours is the first long-form article I got to the bottom of and didn't have 2X the confusions as when I started!
Please write more Git visualized articles. I'll devour them, I swear.
Wow! Never knew about something like Reflog! Thanks for your efforts π€
Beautifully done! Seeing
rebase --onto
visualized would be great too π.Thanks so much for this awesome post. I have one question is that for this paragraph
"""
This example shows rebasing on the master branch. In bigger projects, however, you usually don't want to do that. A git rebase changes the history of the project as new hashes are created for the copied commits!
"""
You rebase the dev branch over the master branch. But you said in bigger projects you don't want to do that. I'm a little confused here. So in a bigger project, what do we do? Do we rebase the master over other branches? Thanks!
When you rebase your branch from a different commit on master, you rewrite the history of your branch. This requires a force push. If there are multiple developers working on that branch, this may cause issues if they have work based on the old history of the branch. Rather than doing a rebase, merging master into the branch may make more sense.
thanks so much for the reply. You mean a force push, do you mean the newer stuff on my branch will be pushed to the mater branch? I'm pretty new so sorry for the dumb questions. Thanks!
TL;DR: Master is unchanged in the process of this rebase example, only the branch is changed.
In the given example, the branch is being based off a different commit than it originally was. In other words, the commits made on master since the branch was originally made will now appear at the start of the branch's history. You will often see this referred to as "replaying commits". The branch commits will have a different hash (you can see this in the example if you look closely), but will have the same contents in them.
git rebase
can also be used to "replay" the commits from the dev branch back onto master, but I'm not as familiar with that work flow, so I won't try to give advice on it.Thanks so much for the awesome reply! Now I understand the flaw of doing this and a better understanding between 'rebase' and 'merge'. I really appreciate it!
I have one question.
For example, I am working on the dev branch. Meanwhile, my colleague has pushed 2 more commits.
What should I do? Should I pull first then commit or should I commit first and then pull?
I am always confused over here.
You cannot pull before commit because git does not know what do with changes in local.
This is what we do.
if you dont want to commit ur changes and still you want to pull data you do stash
stash will push changes to stack and you can get it from it later or you can auto stash
git pull --rebase --auto-stash
Thank you so much for the answer. Very Helpful!
Great post, @lydiahallie ! I'll definitely be using this to help team members in the future.
A few thoughts:
reset --mixed
(default), but an animation would have been greatrebase --onto
, would have been really informativeThanks again for the awesome resource!
TheAvocoder back with another masterpiece. ππΌ
thank uu π₯π