Que doit contenir mon fichier .gitignore pour un projet Android Studio ?

Question

Quels fichiers devraient se trouver dans mon .gitignore pour un projet Android Studio ?

J'ai vu plusieurs exemples qui comprennent tous .iml mais les documents d'IntelliJ disent que .iml doit être inclus dans votre contrôle de source.

Answer 1

Mise à jour vers Android Studio 3.0 Veuillez partager les éléments manquants dans les commentaires.

Une réponse tardive mais este La réponse alternative n'était pas la bonne pour nous ...

Donc, voici notre fichier gitignore :

#built application files
*.apk
*.ap_
*.aab

# files for the dex VM
*.dex

# Java class files
*.class

# generated files
bin/
gen/

# Local configuration file (sdk path, etc)
local.properties

# Windows thumbnail db
Thumbs.db

# OSX files
.DS_Store

# Android Studio
*.iml
.idea
#.idea/workspace.xml - remove # and delete .idea if it better suit your needs.
.gradle
build/
.navigation
captures/
output.json 

#NDK
obj/
.externalNativeBuild

Depuis Android Studio 2.2 et jusqu'à 3.0, les nouveaux projets sont créés avec ce fichier gitignore :

*.iml
.gradle
/local.properties
/.idea/workspace.xml
/.idea/libraries
.DS_Store
/build
/captures
.externalNativeBuild

Déprécié - pour un format de projet plus ancien, ajoutez cette section à votre fichier gitignore :

/*/out
/*/*/build
/*/*/production
*.iws
*.ipr
*~
*.swp

Ce fichier doit être situé dans le dossier racine du projet et non dans le dossier du module du projet.

Notes d'édition :

1. Depuis la version 0.3+, il semble que vous pouvez commiter et pousser *. .iml y build.gradle fichiers. Si votre projet est basé sur Gradle : dans le nouveau dialogue d'ouverture/importation, vous devez cocher l'option "use auto import" et cochez la case "use default gradle wrapper (recommended)" bouton radio. Tous les chemins sont maintenant relatifs comme @George l'a suggéré.

2. Réponse actualisée d'après @128KB source jointe et les suggestions de @Skela

Answer 2

Construire sur mon Android normal .gitignore et après avoir lu la documentation sur le site Web d'Intellij IDEA et les messages sur StackOverflow, j'ai construit le fichier suivant :

# built application files
*.apk
*.ap_

# files for the dex VM
*.dex

# Java class files
*.class

# built native files (uncomment if you build your own)
# *.o
# *.so

# generated files
bin/
gen/

# Ignore gradle files
.gradle/
build/

# Local configuration file (sdk path, etc)
local.properties

# Proguard folder generated by Eclipse
proguard/

# Eclipse Metadata
.metadata/

# Mac OS X clutter
*.DS_Store

# Windows clutter
Thumbs.db

# Intellij IDEA (see https://intellij-support.jetbrains.com/entries/23393067)
.idea/workspace.xml
.idea/tasks.xml
.idea/datasources.xml
.idea/dataSources.ids

Notez également que, comme cela a été souligné, le fichiers natifs construits est principalement utile lorsque vous créez votre propre code natif avec le NDK Android. Si, par contre, vous utilisez une bibliothèque tierce qui inclut ces fichiers, vous pouvez supprimer ces lignes (*.o et *.so) de votre fichier .gitignore.

Answer 3

Mise à jour 7/2015 :

Voici le source définitive de JetBrains

---

Format de projet basé sur un répertoire (répertoire .idea)

Ce format est utilisé par défaut par toutes les versions récentes de l'IDE. Voici ce que vous devez partager :

• Tous les fichiers sous .idea dans le répertoire Root du projet sauf le site workspace.xml y tasks.xml les fichiers qui stockent les paramètres spécifiques de l'utilisateur
• Tous les .iml des fichiers de modules qui peuvent être situés dans différents répertoires de modules (s'applique à IntelliJ IDEA)

Soyez prudent. de partager ce qui suit :

• Artéfacts Android qui produisent une construction signée (contiendra les mots de passe du keystore)
• Dans IDEA 13 et les versions antérieures dataSources.ids , datasources.xml peut contenir les mots de passe de la base de données. IDEA 14 résout ce problème .

Vous pouvez envisager de ne pas partager les éléments suivants :

• gradle.xml, voir cette discussion
• le dossier des dictionnaires de l'utilisateur (pour éviter les conflits si un autre développeur a le même nom)
• Les fichiers XML sous .idea/libraries au cas où ils le seraient généré par Gradle projet

Format de projet hérité ( .ipr / .iml / .iws fichiers)

• Partager le projet .ipr et tous les fichiers .iml les fichiers du module, ne pas partager le site .iws car il stocke les paramètres spécifiques de l'utilisateur

Bien que ces instructions concernent IntelliJ IDEA, elles s'appliquent à 100 % à Android Studio.

---

Voici un .gitignore qui incorpore toutes les règles ci-dessus :

# Android Studio / IntelliJ IDEA 
*.iws
.idea/libraries
.idea/tasks.xml
.idea/vcs.xml
.idea/workspace.xml

Answer 4

J'utilise ce .gitignore. Je l'ai trouvé à : http://th4t.net/Android-studio-gitignore.html

*.iml
*.iws
*.ipr
.idea/
.gradle/
local.properties

*/build/

*~
*.swp

Answer 5

Dans le cas d'Android Studio, les seuls fichiers qui doivent être enregistrés dans le contrôle de version sont les fichiers nécessaires pour construire l'application à partir de la ligne de commande en utilisant gradle. Vous pouvez donc les ignorer :

• *.iml
• .idée
• construire

Cependant, si vous enregistrez des paramètres de l'IDE, tels que des paramètres de style de code personnalisés, ils sont enregistrés dans le dossier .idea. Si vous souhaitez que ces modifications soient prises en compte dans le contrôle de version, vous devez également enregistrer les fichiers IDEA (*.iml et .idea).