Problem
当我们往github上push超过50M的文件时,github会给出警告;而当文件大小超过100M的时候,github会reject。虽然我们一般不推荐往github上push大文件,但当有些资源文件或大型的数据集确实需要用版本管理起来时,我们该如何做呢?
Solution
Git LFS (Git Large File Storage ),它的核心思想可以用下图描述:
如上图所示,Git remote server并没有真正保存上传的大文件,而是有一个文本指针指向了大文件所存储的位置(github有专门存储大文件的地方,因此你可以不用关心它具体存储的位置),如果你本地没有安装git lfs,却clone了一个使用了git lfs的仓库的话,你会发现有些文件是文本类型,并有类似如下内容:
version https://git-lfs.github.com/spec/v1
oid sha256:4b99dbe6fe6f646b2026de93481045bbf34f995559db15fce34d192f1f320ef4
size 156154
这些文件就是文本指针。你可以在安装完git lfs后使用git lfs pull
命令将大文件真正的pull下来。
How to use
去官网(https://git-lfs.github.com/)下载并安装好git lfs,确认环境变量已经配置好;
-
打开命令行运行
git lfs install
以上命令只需执行一次,使git lfs完成全局的配置。
-
针对需要track的大文件运行下面的命令:
# 跟踪单个文件 git lfs track "<file_name>" # 跟踪一类文件,如改成目录的所有以“.zip”结尾的文件 git lfs track "*.zip" # 跟踪“dir”文件夹及其所有内容 git lfs track "dir/**"
git lfs track命令的 track 规则与.gitignore的规则一样,请参考 https://git-scm.com/docs/gitignore。
运行完track命令后所在工程目录会生成
.gitattributes
文件,里面记录了你所track的文件,你也可以直接编辑该文件来改变track规则。接下来注意,先add并commit.gitattributes
文件,按照官网的说法这时再按一般git的操作已经可以push大文件了,但是本人没有试成功,后来参考别人成功的经验是,不仅要add和commit该文件,还要先将该文件push上去,然后再对你的大文件进行普通的git操作。当然,在push之前可以先运行git lfs ls-files
来查看相应的文件是否track成功。
Supplements
-
Git LFS 的详细命令,可以通过
$ git lfs help <command> $ git lfs <command> -h
来查看,或是进入https://github.com/git-lfs/git-lfs/tree/master/docs/man打开任意一个你感兴趣的以
.ronn
为后缀的文件,里面有对该命令的较为详细的描述。 关于Git LFS server的url的问题,可以参考https://github.com/git-lfs/git-lfs/blob/master/docs/api/server-discovery.md。当然,你也可以自己搭建和配置git lfs server并将其url配置到git lfs的客户端。