由于新项目有很多二进制文件存在,使用 git 管理仓库大小很快就会超过免费限额,所以我们需要使用 git-lfs 来管理这部分文件。
git lfs 是什么
git lfs 本质上是 git 的一堆 hook,在提交的时候把需要的文件上传到git lfs服务器,然后把文件替换成一个很小的文件索引提交到 git 服务器。在下载的时候,根据文件索引去git lfs服务器把文件下下来。这样,如果大文件频繁修改,git 服务器上的改动只有一行,历史文件都会在git lfs服务器上面。别人在拉取的时候,也只需要拉取最新的那个文件,而不需要把大文件的所有历史版本下下来。
有了git lfs,在仓库有很多大二进制文件的情况下,加载速度会更快,也更省钱。
git lfs 的搭建
虽然一般git官方都提供了 git lfs 服务,但是一般都比较贵,不划算。我们可以使用我们自己搭的服务。git lfs官方只有一个简单的lfs-test-server 服务,功能较少,但是够用。项目使用 go构建,下载好 go 环境之后,克隆项目,执行go get
安装依赖,然后go build
就可以得到可执行文件了。(注:go get 可能会比较慢,可以镜像加速,执行go env -w GOPROXY=https://goproxy.io,direct
即可。镜像也可以使用其他的,可以自行搜索)
也可以直接go install github.com/github/lfs-test-server@latest
下载,自动编译得到可执行文件。
得到可执行文件后,需要写配置文件。参考如下:
#!/bin/bash
set -eu
set -o pipefail
LFS_LISTEN="tcp://:9999"
LFS_HOST="127.0.0.1:9999"
LFS_CONTENTPATH="content"# 文件保存路径
LFS_ADMINUSER="<cool admin user name>"#管理后台用户名
LFS_ADMINPASS="<better admin password>"#管理后台密码
LFS_PUBLIC=1#是否开启认证,1 不需要认证,0 需要认证,进后台后添加用户才能使用
LFS_CERT="mine.crt"#使用 https 的话,需要填写下面三项
LFS_KEY="mine.key"
LFS_SCHEME="https"
export LFS_LISTEN LFS_HOST LFS_CONTENTPATH LFS_ADMINUSER LFS_ADMINPASS LFS_CERT LFS_KEY LFS_SCHEME LFS_PUBLIC
./lfs-test-server
保存为 start.sh,执行即可启动服务端。windows 类似,写个 bat 将配置注册到环境变量即可。
注:别忘了设置开机启动,否则服务端没启动, git 拉取文件时可能会卡死。
git lfs 的使用
安装 git lfs,内容不赘述了,git lfs install
执行后没报错就代表环境配置成功。由于我们使用的是自己搭的服务器,需要在项目根目录添加.lfsconfig
文件,内容如下:
[lfs]
url = "http://127.0.0.1:9999/"
其中 url 改成服务器地址。
不管是对已有项目的优化,还是新项目的初始化,这篇码云文档写得很详细,可以参考。
git lfs 服务器炸了怎么办
极端情况下,自己搭的git lfs 服务器会有被误删、丢失的情况,那么这就意味着我们的文件永久丢失了吗?非也,git 是分布式的,git lfs 也相当于是分布式的,大家把自己的文件重新上传一次即可。先修改.lfsconfig
文件,将地址更新了,无需提交,直接执行git lfs push origin dev --all
,每个人把自己的分支(示例为 dev 分支)上传一次即可。在服务器缺失文件的情况下,拉取代码可能会卡死,修复完成之后才能正常使用。