How and Why to use Git LFS
Why might I need Git LFS?
To some extent, all software is obsessed with data. Facebook, GitHub, and Dropbox are not very compelling without the data they manage, and Rails wouldn't be near as widely used without ActiveRecord (or some equivalent). That said, all of these examples—and most web applications in general—defer responsibility of that data to a database like Postgres. While they require data to be compelling, their core behavior still exists without it, and users can continue to use the software to add interesting data.
Some applications, on the other hand, require data to function. In game development this is often referred to as data-driven design or data-oriented design. (Not to be confused with the UX paradigm, nor domain-driven design) (For a more concrete example, check out the entity-component-system architecture for game engines.)
For our earlier examples, the relationship between data and behavior is loose, and it's managed equally loosely, with "migrations" to update the database schema as the various data-access models change over time. For these data-driven applications, the data _is_ the behavior, requiring all the care and attention typically paid to code.
Because of this tight coupling between data and the code interpreting it, versioning the two together becomes critical to maintaining this relationship over time: as the code changes, the data changes, and vice-versa. Historically, this need has been met with specialized version-control software like Perforce. (Notably, there are still features unique to Perforce that make it particularly effective in these types of projects, but we'll leave that for another day and another post.)
Recently, there is another option: Git Large File Storage (Git LFS for short).
While data-driven game engines are a convenient example, many applications have a similar relationship:
- A parser for a binary file format and a set of binary test fixtures verifying the parser's behavior.
- A static web site that wants to include images and fonts alongside markup, all deployable via git push.
- A repository for a company's style guide, with source files (such as the
.sketchfiles, naturally) versioned alongside the resulting style guide.
Why wouldn't I use Git LFS?
In order to save space, Git LFS avoids downloading the files it tracks, leaving them on the remote for retrieval as needed. While effective, this technique precludes individual clients from having all of a repository's history available offline.
Using the example of binary test fixtures, for example, you would be unable to run that test suite inside of
git bisect without access to the remote storing the history for those fixtures.
How much space does Git LFS save?
That depends. If most of the binary data over the history of your repository is in "the past" (you have binary files that change a lot), the space savings with respect to those files approaches 100%, mathematically and theoretically speaking. (Practically, I'd expect the savings to be 75% or higher for a repository containing, say, 3MB images that change often.)
Not satisfied to rely on theory alone, this repo contains the tools, method, and results for a series of tests. The results were:
- 10 2KB files, committed 40 times each: 700KB and 72% less disk space
- 1 100MiB file, committed only once: 0B (no cost for large or unchanged files)
- 1 1MiB file, committed 1000 times: 188MB and 98.6% less disk space
These tests also revealed a few other interesting details:
- Committing tracked files is slower, due to the time it takes Git LFS to run its various scripts.
- Uploading and downloading files is faster over Git LFS, though the overhead of setting up the additional connection can nullify this for fewer binary files without a long history.
- Local disk usage for the clients making the changes to tracked files can be higher with Git LFS installed, due to the local bookkeeping Git LFS performs alongside storing all binaries (since they originated at this client). Cleaning out the repository of these binaries (once they've been pushed to the remote, of course) will bring disk usage back down again.
An unfortunate name
Contrary to its name, nothing about Git "Large File" Storage requires anything regarding the size of the files to be versioned. Instead, Git LFS improves upon the default handling of binary, unmergeable, or uncompressable files, storing them independently of the rest of the index.
If those files are added to the repo without Git LFS installed, Git does its best, but it will naïvely compress and store each updated copy just as it would with text. If these binary files are large, or simply change often, the size required to track their history (as opposed to the size of the binaries themselves in the working directory) would be significantly reduced by installing and using Git LFS.
How to use Git LFS
- Each team member will need to download and install the Git LFS extension. Depending on how each team member has configured their machine, this can be as simple as one command to download the extension (on a Mac, this can be
brew install git-lfs; for other environments, see these excellent docs), and
git lfs installto install it.
- In your git repo, you need to tell Git LFS to "track" each kind of binary file:
- To track all
git lfs track *.datfrom within the repo.
- To track all files in
git lfs track images/instead.
- For other options, check out the gitignore pattern format. Git LFS uses the same format!
- To track all
- Add and commit your binary files as normal. (e.g.
git add big-data.dat && git commit -m "Adding our Big Data, powered by Git LFS!")
How it works
Rather than commit your 6GiB "Big Data" file to Git naïvely, LFS uses a handful of extension points already provided by Git: a plaintext "pointer file" added to the index as normal, a
pre-push Git hook to upload changed files, and a set of
.gitattributes options to wire up diffing, filtering, and merging.
The pointer files used by Git LFS describe the file to be tracked, which Git LFS will use in its commands and scripts to infer where to find updated files, where to upload local updates, and so forth. This is what one of these files looks like:
version https://git-lfs.github.com/spec/v1 oid sha256:6fe2e48ef494b7855e6d8f93c59cf38d38350274e304a9ac35102d5c365ee002 size 620773
.gitattributes options (generated by Git LFS when you run
git lfs track) direct Git to use a set of globally configured filters whenever
git merge, and the like try to target LFS-tracked files. This filter is configured when you run
git lfs install, looking something like this:
[filter "lfs"] clean = git-lfs clean -- %f smudge = git-lfs smudge -- %f required = true process = git-lfs filter-process
One of the primary roles for these filters is to ensure only pointer files wind up tracked in the Git index, even though the original binary files remain in the working tree. Likewise, these filters ensure only the pointer file is stored in Git's primary object storage (i.e.
.git/objects), while the binary file and its changes are stored in a separate location (
.git/lfs/objects). (For more information on filters in general, this is a good primer on the topic.)
pre-push hook (generated alongside those
.gitattributes) intercepts your calls to
git push, uploading the original, locally changed binary files just before Git uploads new and updated pointer files.
When you pull the repository onto another machine, the pointer files direct Git LFS to download the binary files needed by the new
HEAD. If 90% of the binary files in the history of the repo aren't needed by the
HEAD commit, then that 90% isn't downloaded (and your local copy will be that much smaller for it).
The primary concern with Git LFS is that it does require using an extension—for the time being, Git LFS does not come with Git. If a team member does not have Git LFS installed, all they will see is the pointer file, not the original binary.
If you'd like to see this in action, this repo explains how to create this scenario using a pair of Docker containers, one with LFS installed, and one without.
(Another potential concern might be users editing pointer files directly, although I did not find evidence or discussion of this at the time of writing.)
Git server support
The following Git hosts currently support hosting Git-LFS-tracked files:
- GitHub (announcement)
- GitLab (announcement)
- BitBucket (announcement)
- Visual Studio Online / Visual Studio Team Services (announcement)
More information on server support can be found on the Git LFS wiki.
Git client support
In addition to the command-line Git LFS client, many graphical Git clients support Git LFS:
Notably, GitKraken does not yet support Git LFS. See their FAQ for more information.
(I tried to find if GitX supports LFS, and couldn't find anything definitive. This issue was the closest I could find, and it hasn't been addressed at the time of writing.)
Knowing the risks of checking in unmergeable, uncompressable, or frequently-changing binaries, one alternative is to check them into Git anyway. For an internal Test Double project, this is exactly what we did. For your project, it might be undesirable.
Another alternative would be to write your own, using some of the same techniques Git LFS does:
.gitattributes and hooks. If you want to support custom workflows, for example, this may be the easiest way to go about it. For most projects, this should be unnecessary.
Lastly, you could write a set of tools around git that similarly manage binary files in cold storage like Amazon's S3. If you have files that shouldn't be versioned in tandem with the rest of the project, but should be made available to all contributors, this is a solid alternative.
All of these alternatives come with a maintenance burden over time—buyer, beware.
For more information, check out the core Git LFS documentation. In particular, the following documents are useful jumping-off points:
- This document on "server discovery": pointing uploads at a specific server independent of the location of the Git remote.
- This document on "extensions": hooking and wrapping the core LFS behavior, e.g. adding a wrapper to sign files before upload.
- The spec for Git LFS, which goes into further detail of the inner-workings of Git LFS.