版本控制与协作 / 系统课时
编写项目忽略规则
编写项目忽略规则
学习目标
完成本课后,你将能够:
- 使用 .gitignore 排除不应提交的文件
- 理解目录、通配符和否定规则
- 验证规则是否命中目标路径
问题背景或应用场景
构建产物、依赖目录、日志、缓存和本地密钥配置不应进入版本库。.gitignore 用规则声明哪些未跟踪路径应被忽略,从源头降低仓库膨胀和敏感信息泄露风险。
核心原理
规则按行匹配,空行和以 # 开头的行可用于组织说明。末尾 / 表示目录,* 匹配单层名称中的任意字符,** 可跨目录,前导 / 限定相对当前 .gitignore 所在目录。以 ! 开头可重新包含路径,但如果父目录整体被排除,重新包含内部文件需要同时处理父目录规则。
.gitignore 只影响未跟踪文件,不会让已经提交的文件自动停止跟踪。敏感密钥即使被忽略,也应通过环境变量或密钥服务管理。
基础用法
先列出项目产生的本地文件,再按类别写规则。使用 git status --short 检查可见文件,使用 git check-ignore -v <路径> 查看命中的规则来源。
完整可运行示例
以下命令使用 Bash 语法,并在独立测试目录中执行。示例只使用本地仓库或本地裸仓库模拟远程服务,不依赖互联网;提交哈希、绝对路径等动态值不作为固定输出。
bash
rm -rf git-ignore-demo
mkdir git-ignore-demo
cd git-ignore-demo
git init -q -b main
mkdir -p build src
printf "binary
" > build/app.bin
printf "runtime
" > app.log
printf "keep
" > important.log
printf "secret
" > .env
printf "source
" > src/app.txt
cat > .gitignore <<'EOF'
build/
*.log
!important.log
.env
EOF
git add .
printf "staged-files:
"
git diff --cached --name-only预期输出
text
staged-files:
.gitignore
important.log
src/app.txtTips
- 规则旁写注释说明原因。
- 用项目官方模板作起点,再删除无关规则。
- 提交前检查是否混入密钥、数据库文件和大型产物。
常见错误
1. 忽略规则过宽
- 错误表现:必要配置模板也被排除。
- 产生原因:使用了范围过大的通配符。
- 正确处理:通过否定规则或更精确路径缩小范围。
- 修复结果:必要文件重新出现在状态列表。
2. 把 ignore 当安全工具
- 错误表现:密钥曾提交后仅添加规则。
- 产生原因:历史中仍保存旧对象。
- 正确处理:立即轮换密钥,并按安全流程清理历史。
- 修复结果:旧密钥失效且未来文件不再提交。
本课练习
1. 忽略构建目录
- 任务目标:练习目录规则。
- 输入或初始条件:项目产生
dist/和源码目录。 - 实现要求:只忽略构建目录。
- 验收条件:源码可暂存,构建文件不可见。
2. 保留特殊日志
- 任务目标:练习否定规则。
- 输入或初始条件:所有日志应忽略,但示例日志需提交。
- 实现要求:使用通配符和否定规则。
- 验收条件:只有目标日志可被暂存。
3. 定位命中规则
- 任务目标:掌握 check-ignore。
- 输入或初始条件:多个
.gitignore文件同时存在。 - 实现要求:查询某个路径。
- 验收条件:能指出具体规则文件和行。
按自己的节奏,确认真正理解。