What should be in my .gitignore for an Android Studio project?

by

Updated to Android Studio 3.0
Please share missing items in comments.

A late answer but this alternative answer was not right for us …

So, here’s our gitignore file:

#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

Since Android Studio 2.2 and up to 3.0, new projects are created with this gitignore file:

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

Deprecated – for older project format, add this section to your gitignore file:


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

This file should be located in the project’s root folder and not inside the project’s module folder.

Edit Notes:

  1. Since version 0.3+ it seems you can commit and push *.iml and build.gradle files. If your project is based on Gradle: in the new open/import dialog, you should check the "use auto import" checkbox and mark the "use default gradle wrapper (recommended)" radio button. All paths are now relative as @George suggested.

  2. Updated answer according to @128KB attached source and @Skela suggestions

Related Contents:

  1. Ignore files that have already been committed to a Git repository [duplicate]
  2. What are the differences between .gitignore and .gitkeep?
  3. .gitignore is ignored by Git
  4. How do I configure git to ignore some files locally?
  5. .gitignore exclude folder but include specific subfolder
  6. How to ignore certain files in Git
  7. Comments in .gitignore?
  8. What to gitignore from the .idea folder?
  9. How to remove files that are listed in the .gitignore but still on the repository?
  10. Can I ‘git commit’ a file and ignore its content changes?
  11. git ignore exception
  12. Should I check in folder “node_modules” to Git when creating a Node.js app on Heroku?
  13. Explain which gitignore rule is ignoring my file
  14. Why is .gitignore not ignoring my files?
  15. git still shows files as modified after adding to .gitignore
  16. Why doesn’t Git ignore my specified file?
  17. Exceptions in .gitignore [duplicate]
  18. git ignore all files of a certain type, except those in a specific subfolder
  19. Using .gitignore to ignore everything but specific directories
  20. Git: How to remove file from index without deleting files from any repository
  21. git add all except ignoring files in .gitignore file
  22. Android studio – should the entire .idea directory be in git ignore?
  23. How to .gitignore files recursively
  24. Git Ignores and Maven targets
  25. OS X – Can’t start Git: /usr/bin/git Probably the path to Git executable is not valid
  26. How to ignore files which are in repository?
  27. .gitignore exclude files in directory but not certain directories
  28. How to track directories but not their files with Git?
  29. Ignoring a directory from a Git repo after it’s been added
  30. what should be in .gitignore file for a netbeans java project?
  31. add #*# glob to .gitignore?
  32. .gitignore NuGet exclude packages/ include packages/repositories.config
  33. git repository ignoring all .dlls
  34. How do I tell Git to ignore a specific filename only in the repository’s top level? [duplicate]
  35. Git-ignore certain files in sub-directories, but not all
  36. How do I remove a directory subtree from the staging area?
  37. .gitignore does not work – file is still being tracked [duplicate]
  38. .gitignore a folder content [duplicate]
  39. Telling git to ignore symlinks
  40. Ignore all files with the same name in git
  41. .gitignore only on local
  42. Git .gitignore to ignore only folder in root directory
  43. git ignore all files except one extension and folder structure
  44. Android Studio – Push failed: fatal: Could not read from remote repository
  45. Is there a way to tell git-status to ignore the effects of .gitignore files?
  46. Gitignore all folders beginning with a period
  47. Git: Ignoring Version-Controlled Files
  48. Git Ignore everything in a directory except subfolders
  49. How do I ignore file extensions in git regardless of case?
  50. .gitignore whitelist on directory and its contents

Leave a Comment