如何提交默认内容文件并让Git永久忽略其本地变更？

核心思路 #

通过Git的--skip-worktree标记忽略本地文件变更，同时用仓库内的初始化脚本让所有克隆用户自动完成配置，无需手动重复执行命令。

仓库所有者操作步骤 #

1. 提交默认文件到远程仓库
   确保目标配置文件（比如app.config）已写入默认内容，执行以下命令完成提交：

   git add app.config
   git commit -m "提交默认配置文件"
   git push origin main
   

2. 创建自动初始化脚本
   在仓库根目录创建setup-local-config.sh脚本（Windows用户可改为.bat格式），内容如下：

   #!/bin/bash
   # 自动标记配置文件为skip-worktree，忽略本地修改
   git update-index --skip-worktree app.config
   echo "本地配置完成：app.config的所有变更将不会被Git追踪"
   

   给脚本添加执行权限：

   chmod +x setup-local-config.sh
   

3. 将脚本提交到仓库
   把初始化脚本加入仓库并推送：

   git add setup-local-config.sh
   git commit -m "添加本地配置初始化脚本"
   git push origin main
   

4. 在README中添加执行提示
   在仓库的README.md里明确告知用户克隆后的操作：

   ### 本地初始化
   克隆仓库后，请执行以下命令完成配置：
   ```bash
   ./setup-local-config.sh
   

开发者克隆后的操作（仅需一次） #

• 克隆仓库：git clone <仓库地址>
• 进入仓库目录：cd <仓库名>
• 执行初始化脚本：./setup-local-config.sh

完成后，修改app.config的任何内容都不会被Git追踪，也不会出现在git status的变更列表中。

之前尝试失败的原因 #

• --assume-unchanged：属于临时忽略标记，Git在拉取等操作中可能重置该状态，且需要用户手动执行
• git rm --cached：会将文件从仓库追踪列表移除，导致后续克隆无法获取该文件
• .gitignore：仅对未被Git追踪的文件生效，已提交到仓库的文件不受影响

内容的提问来源于stack exchange，提问作者trejder