
Go项目里哪些文件必须加进 .gitignore
Go 项目默认不生成二进制,但构建过程和工具链会留下大量干扰文件。不忽略它们,git status 会满屏红,PR 里混入临时文件还可能泄露敏感路径或本地配置。
核心原则:只让源码(*.go)、模块定义(go.mod、go.sum)和必要资源进仓库,其余全过滤。
-
bin/、dist/、output/:常见构建输出目录,Go 工具链不强制,但go build -o bin/app类命令会写入 -
*.out、*.test、*.exe:测试二进制、跨平台构建产物,Windows 下.exe尤其容易误提交 -
go.work和go.work.sum:多模块工作区文件,属于开发者本地协作上下文,不应提交 -
**/vendor/**:除非你明确要求锁定所有依赖副本(已过时做法),否则vendor/应该被忽略——go mod vendor是可选步骤,不是标准流程
为什么不能直接套用 GitHub 的通用 Go 模板
GitHub 官方 .gitignore 模板(如 github/gitignore/blob/main/Go.gitignore)偏保守,会包含 pkg/、**/*.so 等条目,但实际在多数 Go 项目中根本不会生成这些。
更麻烦的是它漏掉了现代 Go 开发的关键项:go.work*、**/go-build-cache/(某些 IDE 插件生成)、以及 .vscode/ 或 .idea/ 这类编辑器目录——它们虽非 Go 特有,但几乎每个团队都用,且极易被新人提交。
立即学习“go语言免费学习笔记(深入)”;
- 如果你用
gopls+ VS Code,.vscode/settings.json可能含本地GOPATH路径,泄露开发机信息 -
**/go-build-cache/是 JetBrains GoLand 的缓存目录,不在标准 Go 模板里,但 git 提交后会导致 CI 构建失败(因路径硬编码) -
**/coverage.out和**/profile.*:测试覆盖率与性能分析输出,每次go test -coverprofile都新建,必须忽略
go mod 相关文件要不要忽略?
只忽略生成的、非声明性的文件。go.mod 和 go.sum 必须提交——它们是依赖状态的唯一权威来源;反过来说,任何由 go mod 命令自动生成的中间文件都不该进仓库。
-
go.mod和go.sum:✅ 提交,不可忽略 -
go.work、go.work.sum:❌ 忽略,纯本地多模块开发用,CI 不读取 -
**/go/pkg/mod/cache/**:❌ 忽略,这是全局模块缓存,路径含绝对路径,提交等于暴露开发者机器结构 -
**/go/pkg/mod/(项目内):通常不存在,若手动go mod download -modfile=xxx生成了局部mod目录,则整个该目录应忽略——它只是缓存镜像,不是源码
不同环境下的兼容性陷阱
Windows 和 macOS 用户常在 .gitignore 里漏掉换行符或大小写问题导致忽略失效。Git 默认对大小写不敏感(尤其 Windows/macOS),但 Go 工具链生成的文件名是严格小写的(如 coverage.out),而编辑器可能写出 Coverage.Out。
- 用
git check-ignore -v coverage.out实测是否真被忽略,别只看文件名匹配 - 避免写
**/Coverage*,改用**/coverage.*,更可靠 - CI 环境(如 GitHub Actions)运行
go test -race时会生成race.out,这个文件名不在常见模板里,需手动加 - 如果项目用了
cgo,**/*.cgo1.go、**/*.cgo2.go是编译中间文件,必须忽略,否则每次go build都触发 git 变更
最易被忽略的是本地调试痕迹:比如 main_debug.go 这种临时文件,或者 ./tmp/ 下手动生成的 JSON 测试数据——它们没走 Go 工具链,但一样污染仓库。与其靠规则猜,不如在项目根目录加一行 tmp/ 和 *_debug.go。










