Git ignore file for Xcode projects

Question

Which files should I include in  gitignore when using Git in conjunction with Xcode

User · Answer

I included these suggestions in a Gist I created on Github  http   gist github com 137348  Feel free to fork it  and make it better

User · Answer

Here s the  gitignore that GitHub uses by default for new Xcode repositories   https   github com github gitignore blob master Objective-C gitignore  It s likely to be reasonably correct at any given time

User · Answer

Based on this guide for Mercurial my  gitignore includes    DS Store   swp    nib  build     pbxuser   perspective   perspectivev3   I ve also chosen to include     mode1v3   mode2v3   which  according to this Apple mailing list post  are  user-specific project settings     And for Xcode 4   xcuserdata

User · Answer

We did find that even if you add the  gitignore and the  gitattribte the   pbxproj file can get corrupted  So we have a simple plan   Every person that codes in office simply discards the changes made to this file  In the commit we simple mention the files that are added into the source  And then push to the server  Our integration manager than pulls and sees the commit details and adds the files into the resources   Once he updates the remote everyone will always have a working copy  In case something is missing then we inform him to add it in and then pull once again   This has worked out for us without any issues

User · Answer

gitignore io  Create useful  gitignore files for your project  Example  macOS Objective-C Swift SwiftPackageManager Carthage   Preview Edit   Steps to use in Terminal  Refer to the YouTube Video   Create Git global config alias  One time only  git config --global alias ignore   gi     curl -L -s https   www gitignore io api        gi    Enter the project directory cd  lt the project directory gt    Generate  gitignore file git ignore macOS Objective-C Swift SwiftPackageManager Carthage  gt  gitignore   Add and commit  gitignore file git add  gitignore git commit -m  quot Add  gitignore file quot

User · Answer

Heres a script I made to auto create your  gitignore and  gitattributes files using Xcode    I hacked it together with a few other people s stuff   Have fun   Xcode-Git-User-Script  No warranties    I suck at most of this - so use at your own peril

User · Answer

I m using both AppCode and XCode  So  idea  should be ignored   append this to Adam s  gitignore         AppCode  idea

User · Answer

You should checkout gitignore io for Objective-C and Swift   Here is the  gitignore file I m using     Xcode  DS Store   build     pbxuser  default pbxuser   mode1v3  default mode1v3   mode2v3  default mode2v3   perspectivev3  default perspectivev3 xcuserdata profile   moved-aside DerivedData  idea    hmap   xccheckout   xcworkspace  default xcworkspace   CocoaPods Pods

User · Answer

I use the following  gitignore file generated in gitignore io       Xcode     build    pbxuser  default pbxuser   mode1v3  default mode1v3   mode2v3  default mode2v3   perspectivev3  default perspectivev3 xcuserdata   xccheckout   moved-aside DerivedData   xcuserstate       Objective-C       Xcode   build    pbxuser  default pbxuser   mode1v3  default mode1v3   mode2v3  default mode2v3   perspectivev3  default perspectivev3 xcuserdata   xccheckout   moved-aside DerivedData   hmap   ipa   xcuserstate    CocoaPods     We recommend against adding the Pods directory to your  gitignore  However   you should judge for yourself  the pros and cons are mentioned at    http   guides cocoapods org using using-cocoapods html should-i-ignore-the-pods-directory-in-source-control   Pods

User · Answer

Adding a  gitignore file for     Mac OS X   Xcode    Swift   This is how I have added a  gitignore file into my Swift project    Select you project in Xcode and right click  rarr  New Group  rarr  name it  Git  Select the Git folder and right click  rarr  Add new file Within the iOS tab  rarr  select Other  rarr  empty file      Give the file name here   gitignore       Confirm the file name and type     Here is the result structure      Open the file and past the below code       file                                                                                                                                                              Title         -  gitignore file                                           For           - Mac OS X  Xcode 7 and Swift Source projects               Updated by    - Ramdhan Choudhary                                         Updated on    - 13 - November - 2015                                                                                                                                                                                               Xcode               Xcode temporary files that should never be committed     Build generated build  DerivedData    NB  NIB XIB files still exist even on Storyboard projects  so we want this    nib   swp     Various settings   pbxuser  default pbxuser   mode1v3  default mode1v3   mode2v3  default mode2v3   perspectivev3  default perspectivev3 xcuserdata     Other   xccheckout   moved-aside   xcuserstate   xcscmblueprint   xcscheme              Mac OS X               Mac OS X temporary files that should never be committed   DS Store  AppleDouble  LSOverride    Icon must end with two  r Icon     Thumbnails        Files that might appear in the root of a volume  DocumentRevisions-V100  fseventsd  Spotlight-V100  TemporaryItems  Trashes  VolumeIcon icns    Directories potentially created on remote AFP share  AppleDB  AppleDesktop Network Trash Folder Temporary Items  apdisk             Objective-C Swift specific              hmap   ipa    CocoaPods     We recommend against adding the Pods directory to your  gitignore  However   you should judge for yourself  the pros and cons are mentioned at    https   guides cocoapods org using using-cocoapods html should-i-check-the-pods-directory-into-source-control     Pods     Carthage     Add this line if you want to avoid checking in source code from Carthage dependencies    Carthage Checkouts  Carthage Build    fastlane     It is recommended to not store the screenshots in the Git repository  Instead  use fastlane to re-generate the  fastlane report xml fastlane screenshots     Well  thanks to Adam  His answer helped me a lot  but still I had to add a few more entries as I wanted a  gitignore file for   Mac OS X   Xcode   Swift  References  this and this

User · Answer

For Xcode 5 I add          Xcode 5 - VCS metadata     xccheckout   From Berik s Answer

User · Answer

Mine is a  bzrignore  but it is the same idea      DS Store   mode1v3   pbxuser   perspectivev3   tm build errors   The tm build errors is for when I use TextMate to build my project  It is not quite as comprehensive as Hagelin  but I thought it was worth posting for the tm build errors line

User · Answer

A Structure of a standerd  gitignore file for Xcode project      DS Store  DS Store       Spotlight-V100  Trashes Icon  ehthumbs db Thumbs db build    pbxuser  default pbxuser   mode1v3  default mode1v3   mode2v3  default mode2v3   perspectivev3  default perspectivev3  default xcworkspace xcuserdata profile   moved-aside DerivedData  idea

User · Answer

I was previously using the top-voted answer  but it needs a bit of cleanup  so here it is redone for Xcode 4  with some improvements   I ve researched every file in this list  but several of them do not exist in Apple s official Xcode documentation  so I had to go on Apple mailing lists   Apple continues to add undocumented files  potentially corrupting our live projects  This IMHO is unacceptable  and I ve now started logging bugs against it each time they do so  I know they don t care  but maybe it ll shame one of them into treating developers more fairly     If you need to customize  here s a gist you can fork  https   gist github com 3786883                                 gitignore file for Xcode4 and Xcode5 Source projects     Apple bugs  waiting for Apple to fix respond         15564624 - what does the xccheckout file in Xcode5 do  Where s the documentation      Version 2 6   For latest version  see  http   stackoverflow com questions 49478 git-ignore-file-for-xcode-projects     2015 updates    - Fixed typo in  xccheckout  line - thanks to  lyck for pointing it out    - Fixed the  idea optional ignore  Thanks to  hashier for pointing this out   - Finally added  xccheckout  to the ignore  Apple still refuses to answer support requests about this  but in practice it seems you should ignore it    - minor tweaks from Jona and Coeur  slightly more precise xc  filtering names    2014 updates    - appended non-standard items DISABLED by default  uncomment if you use those tools    - removed the edit that an SO com moderator made without bothering to ask me   - researched CocoaPods  lock more carefully  thanks to Gokhan Celiker   2013 updates    - fixed the broken  save personal Schemes    - added line-by-line explanations for EVERYTHING  some were missing      NB  if you are storing  built  products  this WILL NOT WORK    and you should use a different  gitignore  or none at all    This file is for SOURCE projects  where there are many extra   files that we want to exclude                                      OS X temporary files that should never be committed     c f  http   www westwind com reference os-x invisibles html   DS Store    c f  http   www westwind com reference os-x invisibles html   Trashes    c f  http   www westwind com reference os-x invisibles html    swp        lock - this is used and abused by many editors for many different things       For the main ones I use  e g  Eclipse   it should be excluded      from source-control  but YMMV       lock files are usually local-only file-synchronization on the local FS that should NOT go in git    c f  the  OPTIONAL  section at bottom though  for tool-specific variations      In particular  if you re using CocoaPods  you ll want to comment-out this line    lock       profile - REMOVED temporarily  on double-checking  I can t find it in OS X docs    profile          Xcode temporary files that should never be committed      NB  NIB XIB files still exist even on Storyboard projects  so we want this        nib          Xcode build files -     NB  slash on the end  so we only remove the FOLDER  not any files that were badly named  DerivedData   DerivedData     NB  slash on the end  so we only remove the FOLDER  not any files that were badly named  build   build            Xcode private settings  window sizes  bookmarks  breakpoints  custom executables  smart groups      This is complicated      SOMETIMES you need to put this file in version control    Apple designed it poorly - if you use  custom executables   they are    saved in this file    99  of projects do NOT use those  so they do NOT want to version control this file       but if you re in the 1   comment out the line    pbxuser      pbxuser  http   lists apple com archives xcode-users 2004 Jan msg00193 html    pbxuser     mode1v3  http   lists apple com archives xcode-users 2007 Oct msg00465 html    mode1v3     mode2v3  http   lists apple com archives xcode-users 2007 Oct msg00465 html    mode2v3     perspectivev3  http   stackoverflow com questions 5223297 xcode-projects-what-is-a-perspectivev3-file    perspectivev3       NB  also  whitelist the default ones  some projects need to use these  default pbxuser  default mode1v3  default mode2v3  default perspectivev3          Xcode 4 - semi-personal settings     Apple Shared data that Apple put in the wrong folder   c f  http   stackoverflow com a 19260712 153422       FROM ANSWER  Apple says  don t ignore it        FROM COMMENTS  Apple is wrong  Apple code is too buggy to trust  there are no known negative side-effects to ignoring Apple s unofficial advice and instead doing the thing that actively fixes bugs in Xcode   Up to you  but     current advice  ignore it    xccheckout        OPTION 1  ---------------------------------       throw away ALL personal settings  including custom schemes        - unless they are  shared     As per build  and DerivedData   this ought to have a trailing slash     NB  this is exclusive with OPTION 2 below xcuserdata     OPTION 2  ---------------------------------       get rid of ALL personal settings  but KEEP SOME OF THEM       - NB  you must manually uncomment the bits you want to keep     NB  this  requires  git v1 8 2 or above  you may need to upgrade to latest OS X       or manually install git over the top of the OS X version   NB  this is exclusive with OPTION 1 above    xcuserdata              requires option 2 above   Personal Schemes     xcuserdata    xcschemes           Xcode 4 workspaces - more detailed     Workspaces are important  They are a core feature of Xcode - don t exclude them        Workspace layout is quite spammy  For reference        root         project-name  xcodeproj        project pbxproj        project xcworkspace          contents xcworkspacedata          xcuserdata              your name  xcuserdatad              UserInterfaceState xcuserstate        xcshareddata           xcschemes             shared scheme name  xcscheme        xcuserdata            your name  xcuserdatad             private scheme  xcscheme           xcschememanagement plist             Xcode 4 - Deprecated classes     Allegedly  if you manually  deprecate  your classes  they get moved here      We re using source-control  so this is a  feature  that we do not want     moved-aside         OPTIONAL  Some well-known tools that people use side-by-side with Xcode   iOS development     NB  I d rather not include these here  but gitignore s design is weak and doesn t allow       modular gitignore  you have to put EVERYTHING in one file      COCOAPODS      c f  http   guides cocoapods org using using-cocoapods html what-is-a-podfilelock   c f  http   guides cocoapods org using using-cocoapods html should-i-ignore-the-pods-directory-in-source-control     Podfile lock     RUBY      c f  http   yehudakatz com 2010 12 16 clarifying-the-roles-of-the-gemspec-and-gemfile      Gemfile lock     IDEA      c f  https   www jetbrains com objc help managing-projects-under-version-control html search workspace xml      idea workspace xml     TEXTMATE      -- UNVERIFIED  c f  http   stackoverflow com a 50283 153422    tm build errors         UNKNOWN  recommended by others  but I can t discover what these files are

User · Answer

I recommend using joe to generate a  gitignore file   For an iOS project run the following command     joe g osx xcode  gt   gitignore  It will generate this  gitignore    DS Store  AppleDouble  LSOverride  Icon       DocumentRevisions-V100  fseventsd  Spotlight-V100  TemporaryItems  Trashes  VolumeIcon icns   AppleDB  AppleDesktop Network Trash Folder Temporary Items  apdisk  build  DerivedData    pbxuser  default pbxuser   mode1v3  default mode1v3   mode2v3  default mode2v3   perspectivev3  default perspectivev3 xcuserdata    xccheckout   moved-aside   xcuserstate

User · Answer

The people of GitHub have exhaustive and documented  gitignore files for Xcode projects   Swift  https   github com github gitignore blob master Swift gitignore  Objective-C  https   github com github gitignore blob master Objective-C gitignore

User · Answer

Most of the answers are from the Xcode 4-5 era  I recommend an ignore file in a modern style    Xcode Project      xcodeproj xcuserdata       xcworkspace xcuserdata       xcworkspace xcshareddata IDEWorkspaceChecks plist      xcworkspace xcshareddata   xccheckout      xcworkspace xcshareddata   xcscmblueprint      playground    timeline xctimeline  idea     Build build  DerivedData    ipa    CocoaPods Pods     fastlane fastlane report xml fastlane Preview html fastlane screenshots fastlane test output fastlane sign amp cert    CSV   orig  svn    Other     DS Store   swp   save       bak  Keep it updated from  https   github com BB9z iOS-Project-Template blob master  gitignore

User · Answer

Best of all       gitignore io   Go and choose your language  and then it ll give you the file

User · Answer

Regarding the  build  directory exclusion -   If you place your build files in a different directory from your source  as I do  you don t have the folder in the tree to worry about   This also makes life simpler for sharing your code  preventing bloated backups  and even when you have dependencies to other Xcode projects  while require the builds to be in the same directory as each other   You can grab an up-to-date copy from the Github gist https   gist github com 708713  My current  gitignore file is    Mac OS X   DS Store    Xcode   pbxuser   mode1v3   mode2v3   perspectivev3   xcuserstate project xcworkspace  xcuserdata     Generated files   o   pyc    Python modules MANIFEST dist  build     Backup files    nib

User · Answer

For Xcode 4 I also add   YourProjectName xcodeproj xcuserdata   YourProjectName xcodeproj project xcworkspace xcuserdata

User · Answer

I ve added   xcuserstate xcsettings   and placed my  gitignore file at the root of my project   After committing and pushing   I then ran   git rm --cached UserInterfaceState xcuserstate WorkspaceSettings xcsettings   buried with the folder below    lt my project name gt   lt my project name gt  xcodeproj project xcworkspace xcuserdata  lt my user name gt  xcuserdatad    I then ran git commit and push again

[xcode] Git ignore file for Xcode projects

Examples related to xcode

Examples related to git

Examples related to macos

Examples related to version-control

Examples related to gitignore