如何在本地配置Git忽略某些文件

技术背景

在使用Git进行项目管理时，有时我们希望某些文件只在本地存在，不被纳入版本控制，或者不想让本地对某些文件的修改影响到版本库。例如，辅助文件、用户特定的工作流文件等。这就需要配置Git来忽略这些文件。

实现步骤

1. 使用$GIT_DIR/info/exclude文件

特定于某个仓库但无需与其他相关仓库共享的模式，可放入$GIT_DIR/info/exclude文件中。该文件格式与.gitignore文件相同。

echo YOUR_FILE_OR_DIRECTORY >> .git/info/exclude

如果未生效，可运行以下命令：

git update-index --assume-unchanged YOUR_FILE_OR_DIRECTORY

2. 设置全局忽略文件

可以通过设置core.excludesFile指定一个包含全局忽略模式的文件。

git config --global core.excludesfile ~/.gitignore

然后在~/.gitignore文件中添加需要忽略的模式。

3. 使用git update-index命令

• 忽略本地对已跟踪文件的更改：

git update-index --assume-unchanged <file-list>

取消忽略：

git update-index --no-assume-unchanged <file-list>

• 另一种方式是使用--skip-worktree：

git update-index --skip-worktree <file-list>

取消：

git update-index --no-skip-worktree <file-list>

4. 创建仓库特定的忽略文件

# 在项目文件夹中
nano .gitignore.local
git config core.excludesfile .gitignore.local

# 将其添加到实际的.gitignore中
echo ".gitignore.local" >> .gitignore

5. 在子模块中忽略文件

编辑my-parent-repo/.git/modules/my-submodule/info/exclude文件，格式与.gitignore相同。

6. 忽略目录下的所有文件

使用git update-index --skip-worktree path/to/directory/*忽略目录下的所有文件。

核心代码

设置Git别名简化操作

git config --global alias.ignore 'update-index --skip-worktree'
git config --global alias.unignore 'update-index --no-skip-worktree'
git config --global alias.ignored '!git ls-files -v | grep "^S"'

使用示例：

git ignore config.xml
git unignore config.xml
git ignored

自动化添加忽略文件

Linux

alias git-ignore='echo $1 >> ##FILE-NAME##'
alias git-show-ignored='cat ##FILE-NAME##'
git-unignore(){
  GITFILETOUNIGNORE=${1//\//\\\/}
  sed -i "/$GITFILETOUNIGNORE/d" ##FILE-NAME##
  unset GITFILETOUNIGNORE
}

MacOS

alias git-ignore='echo $1 >> ##FILE-NAME##'
alias git-show-ignored='cat ##FILE-NAME##'
git-unignore(){
  GITFILETOUNIGNORE=${1//\//\\\/}
  sed -i.bak "/$GITFILETOUNIGNORE/d" ##FILE-NAME##
  rm ##FILE-NAME##.bak
  unset GITFILETOUNIGNORE
}

最佳实践

• 对于通用的忽略规则，如.pyc、.pyo文件，建议使用全局忽略文件~/.gitignore。
• 对于特定于某个仓库的忽略规则，使用$GIT_DIR/info/exclude或仓库特定的.gitignore.local文件。
• 使用Git别名可以简化操作，提高效率。

常见问题

--assume-unchanged和--skip-worktree的区别

--assume-unchanged和--skip-worktree都可用于忽略文件的本地更改，但--skip-worktree更适合开发者在不担心提交更改的情况下修改文件。详细区别可参考Borealid的解释。

忽略文件未生效

如果编辑忽略规则后，未生效且已有未暂存的更改，需要运行git update-index --assume-unchanged <file-list>或git update-index --skip-worktree <file-list>。

频繁更改的文件处理

对于频繁更改且不应提交的文件，不应一开始就将其纳入跟踪。应将其文件名添加到.git/info/exclude或全局.gitignore文件中。