github/gitignore · Gradle.gitignore
Gradle .gitignore 模板详解
说明 Gradle.gitignore 在忽略 .gradle 和 build 目录的同时,用否定模式恢复 src 下的 build 目录和 Gradle 包装器 jar 的结构。
Gradle.gitignore 只有 9 行,却三次使用否定模式来准确保护不应被忽略的内容。它大多与 Java、Kotlin 模板一起使用。
Gradle 包装器(gradlew、gradle/wrapper/gradle-wrapper.jar、gradle-wrapper.properties)能让没有安装 Gradle 的人也用相同版本构建,因此必须提交。Gradle 官方文档也建议将包装器文件纳入版本控制。
逐条规则详解
| 模式 | 忽略什么,为什么忽略 |
|---|---|
.gradle | Gradle 缓存保存各项目任务缓存和文件哈希的目录。删除后会在下次构建时重新生成。 |
**/build/!**/src/**/build/ | 构建目录与例外排除所有模块的 build/ 输出目录,但如果源码树(src/)中恰好有名为 build 的包或目录,则将其恢复。例如防止 src/main/java/com/example/build/ 被误认为构建产物而丢失。 |
!gradle-wrapper.jar!gradle-wrapper.properties | 保护包装器重新包含包装器 jar,防止 Java、Kotlin 模板的 *.jar 规则将其忽略。git 遵循最后匹配的规则,因此这一行必须位于 *.jar 之后才有效。 |
gradle-app.setting.gradletasknamecache | GUI 与任务缓存Gradle GUI 设置以及用于 shell 自动补全的任务名缓存。 |
.project.classpath | Eclipse 生成文件Eclipse Buildship 根据 Gradle 配置生成的项目文件。随时可以从构建脚本重新生成。 |
实践中的注意事项
- 在生成器中先选择 Java(或 Kotlin),后选择 Gradle。如果顺序相反,
!gradle-wrapper.jar会排在前面,而后面的*.jar又会将其忽略。可以把gradle/wrapper/gradle-wrapper.jar放进模式测试器确认。 gradle.properties不属于忽略对象。但个人签名信息或令牌应放在用户主目录的~/.gradle/gradle.properties中,而不是项目文件里。- 此模板不包含
local.properties(Android SDK 路径),如果是 Android 项目,请同时使用 Android 模板。
原始模板
Gradle.gitignore
.gradle**/build/!**/src/**/build/# Ignore Gradle GUI configgradle-app.setting# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)!gradle-wrapper.jar# Avoid ignore Gradle wrapper properties!gradle-wrapper.properties# Cache of project.gradletasknamecache# Eclipse Gradle plugin generated files# Eclipse Core.project# JDT-specific (Eclipse Java Development Tools).classpath
模板来源: github/gitignore/Gradle.gitignore @356fd7b (2026-09-11) · CC0-1.0