The trials and tribulations of Git LFS

25 August 2018

At work, we recently started using Git LFS to track large files like images. It reduces the size of your repository by storing the files on an external server and only tracking the pointers to those files inside Git.

Today, I thought it’d be awesome to add Git LFS support to my website. It was pretty simple to do… GitHub has some great directions. However, after pushing my changes, all my assets weren’t loading on my site! Sigh. To help resolve, I found this GitHub issue. Basically, the workaround is to get the full URL of where the asset is located rather than using relative paths, which is most likely serving up the pointer text file.

To get the full URL of an asset tracked with Git LFS, navigate to it on GitHub and copy the image address like so:

Getting the link to your asset when using Git LFS
Getting the link to your asset when using Git LFS

The URL essentially has the following format:

https://media.githubusercontent.com/media/<username>/<repository>/<branch>/<filename>

For assets that you plan to upload, update the URL format for your specific username, repository, branch, and filename. Unfortunately, you won’t be able to see the image until you push, but at least it will be there when your site is live!

comments powered by Disqus