从Git仓库中移除文件但不删除本地文件系统中的文件

技术背景

在使用Git进行版本控制时，有时我们会误将某些文件提交到仓库，或者希望仓库不再跟踪某些文件，但又不想删除本地文件系统中的这些文件。例如，配置文件、日志文件或者IDE生成的临时文件等。此时，就需要一种方法从Git仓库中移除这些文件，同时保留本地文件。

实现步骤

移除单个文件

使用 git rm --cached 命令可以从暂存区移除文件，但保留本地文件：

git rm --cached file_to_remove.txt

移除单个目录

要移除单个目录，需要加上 -r 选项以递归方式移除：

git rm --cached -r directory_to_remove

根据 .gitignore 移除文件

若要根据 .gitignore 文件的规则从仓库中移除文件，可结合 git ls-files 命令：

# Linux/Mac
git rm --cached `git ls-files -i -c -X .gitignore`
# Windows Powershell
git rm --cached $(git ls-files -i -c -X .gitignore)

移除文件夹的完整步骤

1. 从暂存区移除文件夹：

git rm -r --cached File-or-FolderName

2. 提交更改：

git commit -m "Removed folder from repository"

3. 推送到远程仓库：

git push origin master

通用解决方案

1. 编辑 .gitignore 文件，添加要忽略的文件或文件夹：

echo mylogfile.log >> .gitignore

2. 从索引中移除所有项目：

git rm -r -f --cached .

3. 重建索引：

git add .

4. 进行新的提交：

git commit -m "Removed mylogfile.log"

忽略文件更改

若想忽略文件的更改，可使用 git update-index --assume-unchanged 命令：

git update-index --assume-unchanged file_name_with_path

使用 filter-branch 移除文件或文件夹

此方法可从所有提交中移除文件或文件夹：

# 移除文件
git filter-branch --tree-filter 'rm file'
# 移除文件夹
git filter-branch --tree-filter 'rm -rf directory'

指定提交范围：

git filter-branch --tree-filter 'rm -rf directory' HEAD
git filter-branch --tree-filter 'rm -rf vendor/gems' t49dse..HEAD

推送更改到远程仓库：

git push origin master --force

核心代码

以下是几个核心命令的总结：

# 移除单个文件
git rm --cached file_to_remove.txt
# 移除单个目录
git rm --cached -r directory_to_remove
# 根据 .gitignore 移除文件
git rm --cached `git ls-files -i -c -X .gitignore`
# 忽略文件更改
git update-index --assume-unchanged file_name_with_path
# 使用 filter-branch 移除文件夹
git filter-branch --tree-filter 'rm -rf directory'

最佳实践

• 使用 .gitignore：在项目开始时，就创建并维护好 .gitignore 文件，避免不必要的文件被提交到仓库。
• 备份敏感数据：如果要移除包含敏感信息的文件，如密码文件，应先备份这些文件，然后及时更改密码。
• 谨慎使用 filter-branch：filter-branch 会修改仓库的历史记录，可能会影响其他开发者的工作，使用前需与团队成员沟通。

常见问题

使用 git rm --cached 推送到远程仓库后，其他成员的文件被删除

git rm --cached 会从远程仓库移除文件，当其他成员拉取更新时，这些文件会被删除。因此，此方法适用于未推送到远程或其他成员不关心这些更改的情况。

assume-unchanged 和 skip-worktree 的区别

assume-unchanged 假设开发者不再修改文件，而 skip-worktree 指示Git不再处理特定文件。当添加配置文件到仓库但不想跟踪其更改时，skip-worktree 更有用。