在使用 Git 进进程式项目或是其它任何项目的版本控制时,通常会使用 .gitignore 文件来让 Git 在使用 add 将文件纳入 Git 的版本控制清单时,过滤掉指定的目录或文件。通常这些被过滤的文件是由项目在进行建置时所产生出来的任何文件,以及一些用户需要自行修改或是创建的设置档(例如存放数据库登录信息的设置档)。但我们都是人,难免会忘记把要过滤掉的文件加进 .gitignore 中,而使得该文件不小心被 commit 进我们的仓库之中。有时候不小心 commit 进去的甚至是大小超过数十 MB 的文件,或是一些存放着帐号密码、密钥等与安全性直接相关的设置档,这可就不太妙了。

一旦 Git 中的大档愈多,在进行 git clone 的时候就会变得愈来愈慢,而且 GitHub、BitBucket 等主流的 Git 远程仓库服务商,通常会限制仓库中单一文件的大小与整个仓库的大小。

您可能会问:难道不小心 commit 进 Git 的文件,不是直接在项目底下删掉后,再重新 commit 就好了吗?……OK,我们来做个小小的实验吧!

假设有个项目,只有 Hello World 这个二进制档,存在于项目的根目录中。我们先将目前工作目录移动到这个项目的根目录,接着使用以下指令来初始化 Git。

git init

然后使用以下指令,将 Hello World 文件加进 Git 的版本控制清单中。

git add Hello\ World

接着使用以下指令来进行 commit。

git commit -m 'Hello!'

将 Hello World 加入 Git 并 commit

然后用以下指令将 Hello World 文件从项目中删除。

rm Hello\ World

然后再次使用以下指令,将项目的根目录加进 Git 的版本控制清单中。

git add .

接着使用以下指令来进行 commit。

git commit -m 'Delete Hello World'

删除 Hello World 后再次 commit

然后运行以下指令,暂时回到前一个 commit 时的状态。

git checkout HEAD~1

最后运行 ls 指令,列出目前项目根目录底下有哪些文件。

回到前一个 commit 后又出现的 Hello World

如上图,看到没?原本被我们删除的 Hello World 文件又跑出来了!它根本就没有被删除嘛!

删除 Git 中已经被 commit 的文件

显示目前项目的 Git 仓库究竟占用了多少空间

以下指令,可以显示目前项目的 Git 仓库所占用的文件空间:

git count-objects -vH

size 字段加上 size-pack 字段所显示的值就是 Git 仓库所占用的文件空间。

以 git count-objects 查看仓库大小

如上图,可知目前笔者这个 Android 项目的 Git 仓库居然占用了 1.47 GiB 的空间。

将 Git 仓库中的文件依照大小排序并显示出来

以下指令,可以列出目前 Git 仓库中的所有文件,并且按照文件大小来排序:

git rev-list --objects --all | git cat-file --batch-check='%(objecttype) %(objectname) %(objectsize) %(rest)' | sed -n 's/^blob //p' | sort --numeric-sort --key=2 | cut -c 1-12,41- | $(command -v gnumfmt || echo numfmt) --field=2 --to=iec-i --suffix=B --padding=7 --round=nearest

列出 Git 仓库中所有文件的大小

依大小排序的 Git 仓库文件清单

如上图,基本上可以看出笔者的这个 Git 仓库把 Android 所建置出来的 APK 档也加进来了,所以才会那么肥大。

这个指令有个要注意的地方是,如果有同样的文件但保存在不同的路径,只会显示出其中一个路径哦!在之后要删除的时候必须要把每个路径的该文件都删除,该文件才会真正地从 Git 仓库中移除。

确认要排除在 Git 之外的文件,是否已经在 .gitignore 中

以下指令,可以检查要排除在 Git 之外的文件,是否已经在 .gitignore 中:

git check-ignore -v --no-index 文件路径

这边的 文件路径 是指文件在 Git 仓库中的路径。由于已经被 commit 的文件不受 .gitignore 的影响,git check-ignore 指令预设会略过它们,所以要加上 --no-index 参数。

如果在运行指令后,看到屏幕上显示:

.gitignore:行号:规则 文件路径

表示目前那个文件已经在 .gitignore 中了,前面会显示是哪个 .gitignore 文件的第几行规则排除了它。如果什么都没有显示,就表示那个文件还没有被加进 .gitignore 中。

将要排除在 Git 之外的文件加进 .gitignore 中

Git 仓库底下的 .gitignore 文件可以设置要排除加入的文件或是目录。如果您不知道怎么设置,可以在以下这个网站搜索到很多针对不同编程语言和 IDE 用的 .gitignore 模板。

在修改完 .gitignore 后,运行以下指令来重新套用:

git rm -r --cached .

以 git rm -r --cached 重新套用 .gitignore

如果有需要的话,可以立刻再重新将项目根目录加进版本控制清单中,并再 commit 一次,指令如下:

git add . && git commit -m 'update .gitignore'

重新加入并 commit 更新后的 .gitignore

将已经被 commit 进 Git 仓库的文件删除

以下指令,可以把已经被 commit 进 Git 仓库的文件或整个目录给删除:

git filter-branch --force --tree-filter 'rm -f -r "文件路径"' -- --all

这边的 文件路径 是指文件在 Git 仓库中的路径,不支持 wildcard 写法。注意这个指令会直接将有包含指定文件的 commit 进行修改,而导致该 commit 的哈希值以及这个 commit 之后的所有 commit 的哈希值都会发生变化。

以 git filter-branch 删除已 commit 的文件

另外还有一点要注意的是,在运行一次以上指令之后,就算有确实将指定的文件删除掉,再次使用这篇文章先前提到的将 Git 仓库中的文件显示出来的指令,也可能还是会看到那个应该已经要被删除掉的文件仍然出现在清单中,它会在这个 Git 仓库有其它变动(例如创建新的 commit)后,文件列表才会跟着刷新。

如果要立刻刷新文件列表,可以运行以下指令:

git filter-branch --force

清除 Git 的 Reflog 并手动调用垃圾回收机制

以下指令,可以清除 Git 的 Reflog 并手动调用垃圾回收机制,来实时让 Git 仓库将可用空间释放出来。如果并非迫切地需要发布空间,建议不要运行这个指令。

git reflog expire --expire=now --expire-unreachable=now --all && git gc --prune=all --aggressive

覆盖远程的 Git 仓库

若您已经不幸地将要排除在 Git 仓库之外的文件给上传到远程的 Git 仓库,那么就在处理好本地端的 Git 仓库之后,使用以下指令来覆盖远程的 commit 吧!

git push --force --all