Android .gitignore テンプレート解説

Android.gitignore は Android Studio と Gradle で作るアプリプロジェクト向けである。Gradle のビルドキャッシュと成果物、開発者のコンピューターでのみ意味を持つ SDK のパス、アプリ署名キーのような機密ファイルを防ぐ。

IDE フォルダー .idea/ を丸ごと無視する点が JetBrains テンプレートと異なる。コードスタイルや実行構成をチームと共有するには、このルールを調整する必要がある。

ルール別の解説

パターン	何を、なぜ無視するか
.gradle/build/.kotlin/	Gradle キャッシュ・ビルドGradle のタスクキャッシュ、モジュールごとのビルド結果、Kotlin 2.0 プラグインのデータである。すべて再作成される。
local.properties	ローカル設定Android SDK・NDK のインストールパス(sdk.dir)が入っているため、人によって値が異なる。Android Studio が自動的に作成する。
.externalNativeBuild/.cxx/	ネイティブビルドCMake・ndk-build で C/C++ コードをビルドするときに生成される中間フォルダーである。
*.apk*.aaboutput-metadata.json	アプリパッケージビルドされた APK・App Bundle とそのメタデータである。ストアへのアップロードやデプロイパイプラインで扱う。
*.iml.idea/misc.xmldeploymentTargetDropDown.xmlrender.experimental.xml	IDE ファイルAndroid Studio のモジュールファイルと IDE 設定フォルダー、選択したデプロイ先デバイスなど個人の状態を含むファイルである。
*.jks*.keystore	署名キーアプリの署名に使うキーストアである。流出すると他人が同じ署名でアプリを配布できるため、リポジトリに入れない。
google-services.json	Firebase・Google サービス設定Firebase プロジェクトの識別子と API キーが入っている。秘密鍵ではないが、公開リポジトリなら除外することが多く、除外した場合は CI で別途配置しないとビルドできない。
captures/*.hprof*.log	診断ファイルプロファイラーのキャプチャとヒープダンプ、ログである。容量が大きく、一時的なものである。

実務での注意点

• gradlew、gradlew.bat、gradle/wrapper/ はコミットする。このテンプレートは *.jar を無視しないが、Java テンプレートと併用するなら Gradle テンプレートを後ろに置いてラッパー jar を残す。
• コードスタイル(.idea/codeStyles/)を共有したいなら、.idea/ の代わりに JetBrains テンプレートの細分化されたルールを使う。
• google-services.json をコミットするチームならこの行を削除する。いずれにしても、サービスアカウントキー(JSON)はコミットしない。

元のテンプレート

# Gradle files.gradle/build/.kotlin/# Local configuration file (sdk path, etc)local.properties# Log/OS Files*.log# Android Studio generated files and folderscaptures/.externalNativeBuild/.cxx/*.aab*.apkoutput-metadata.json# IntelliJ*.iml.idea/misc.xmldeploymentTargetDropDown.xmlrender.experimental.xml# Keystore files*.jks*.keystore# Google Services (e.g. APIs or Firebase)google-services.json# Android Profiling*.hprof

一緒に使うテンプレート

ほかのテンプレートの解説