Git ignore el archivo para proyectos Xcode


Respuestas:


693

Anteriormente estaba usando la respuesta más votada, pero necesita un poco de limpieza, por lo que aquí se rehizo para Xcode 4, con algunas mejoras.

Investigué todos los archivos de esta lista, pero varios de ellos no existen en la documentación oficial de Xcode de Apple, así que tuve que ir a las listas de correo de Apple.

Apple continúa agregando archivos indocumentados, potencialmente corrompiendo nuestros proyectos en vivo. Este en mi humilde opinión es inaceptable, y ahora he comenzado a registrar errores cada vez que lo hacen. Sé que no les importa, pero quizás avergonzaría a uno de ellos para tratar a los desarrolladores de manera más justa.


Si necesita personalizar, aquí hay una esencia que puede bifurcar: 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
#

61
No debe ignorar *.locko Podfile.lock(no importa la redundancia). Desea exactamente las mismas versiones instaladas en todos los espacios de trabajo, no desea la "última versión".
tvon

8
He eliminado la parte de Podfile. No agregué eso originalmente, SO dice que alguien más lo agregó y lo copié / pegué descuidadamente en la esencia. Mis disculpas por cualquier / toda confusión y malentendido. Realmente no me gusta la forma en que StackOverflow permite que cualquiera edite sus respuestas :(.
Adam

55
Ahora hay una línea explicativa para TODO, línea por línea. Esto debería hacerlo mucho más claro y facilitar la personalización de sus propios proyectos.
Adam

3
@Adam Como puedo ver, este archivo contiene metadatos de VCS y, por lo tanto, no debe registrarse en el VCS. No, no hay menciones developer.apple.comsobre xccheckout. Pero en la página oficial de github, este archivo ya está incluido en el archivo gitignore. https://github.com/github/gitignore/blob/master/Objective-C.gitignore
skywinder

3
Sin una descripción oficial, no vamos a ignorar nada. Casi cada vez que la gente hace eso, tarde o temprano corrompe el proyecto de alguien. Demasiado peligroso, no vayas allí. ¡Así que me niego a agregar algo a este archivo a menos que tenga una fuente verificable que confirme que es seguro ignorarlo!
Adam

276

Basado en esta guía para Mercurial, mi .gitignore incluye:

.DS_Store
*.swp
*~.nib

build/

*.pbxuser
*.perspective
*.perspectivev3

También he elegido incluir:

*.mode1v3
*.mode2v3

que, según esta publicación de la lista de correo de Apple , son "configuraciones de proyecto específicas del usuario".

Y para Xcode 4:

xcuserdata

52
No me gustan particularmente los patrones .pbxuser / .perspective / *. Perspectivev3. Prefiero lo siguiente .xcodeproj / ! *. Xcodeproj / project.pbxproj Eso ignora todo lo que hay dentro de * .xcodeproj excepto el project.pbxproj.
Lily Ballard

55
No ignoro * .pbxuser, * .perspective y * .perspectivev3 porque me gusta mantener esas configuraciones atrás cuando clono mi repositorio.
lajos

77
También es posible que desee agregar que puede hacer un archivo gitignore "global" como este: git config --global core.excludesfile ~ / .gitignore
Jess Bowers

63
Me gustaría advertir a todos los que agregaron el archivo .gitignore después de haber comprometido el proyecto: esos archivos que ignoras aún se están rastreando. Tendrás que eliminarlos de git manualmente usandogit rm --cached <files>
pixelfreak

21
@SpacyRicochet: el formato del comentario aparentemente ha cambiado desde que escribí el comentario. De ahí la cursiva. Se supone que mi patrón se parece a * .xcodeproj / *! *. Xcodeproj / project.pbxproj. Por supuesto, en estos días es necesario ajustarlo para espacios de trabajo.
Lily Ballard

64

Con respecto a la exclusión del directorio 'build' -

Si coloca sus archivos de compilación en un directorio diferente de su fuente, como lo hago yo, no tiene que preocuparse por la carpeta en el árbol.

Esto también simplifica la vida para compartir su código, evitando copias de seguridad hinchadas e incluso cuando tiene dependencias de otros proyectos de Xcode (al tiempo que requiere que las compilaciones estén en el mismo directorio)

Puede obtener una copia actualizada de la esencia de Github https://gist.github.com/708713

Mi archivo .gitignore actual es

# 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

77
Tengo la carpeta de compilación fuera de la carpeta del proyecto, pero cuando otros usuarios compilan el proyecto, por defecto se recrea en el proyecto, por lo que descubrí que agregarlo al archivo de ignorar es una mejor solución, de lo contrario, se vuelve a leer en su se compromete
lajos

58

Para Xcode 4 también agrego:

YourProjectName.xcodeproj/xcuserdata/*
YourProjectName.xcodeproj/project.xcworkspace/xcuserdata/*

78
Si solo agrega xcuserdata, eso se ocupa de ambos.
ma11hew28

77
Por alguna razón, simplemente agregar xcuserdata sin el prefijo no funcionó para mí. Sin embargo, pensé que debería. Impar.
BastiBen

24

Incluí estas sugerencias en un Gist que creé en Github: http://gist.github.com/137348

Siéntase libre de bifurcarlo y mejorarlo.


55
También uno de los chicos de Github ha recopilado algunos archivos .gitignore. Aquí es lo específico de Objective-C de uno github.com/github/gitignore/blob/master/Objective-C.gitignore
program247365

También la gente de Thoughtbot se le ocurrió este proyecto: github.com/thoughtbot/liftoff que agregará un archivo .gitignore predeterminado y sensato, vea su publicación de blog en él: robots.thoughtbot.com/post/33796217972/…
program247365

14

La gente de GitHub tiene archivos .gitignore exhaustivos y documentados para proyectos de Xcode:

Swift: https://github.com/github/gitignore/blob/master/Swift.gitignore

Objetivo-C: https://github.com/github/gitignore/blob/master/Objective-C.gitignore


55
Esto ya se ha publicado en una de las respuestas anteriores. Lo encontré: incorrecto, cuestionablemente compatible (¡más de 100 solicitudes de extracción pendientes!) E indocumentado. El hecho de que sea "incorrecto" es lo peor de todo; han ignorado que solo funciona para un conjunto limitado de usos y no han explicado qué o por qué. Por lo tanto: mi respuesta anterior, que corrige sus errores Y explica lo que se está haciendo y por qué, para que pueda tomar decisiones informadas proyecto por proyecto (en un proyecto nuevo, a veces olvido por qué algunos de los elementos están ahí, los comentarios me ayudan a decidir :))
Adam

@ Adam: GitHub .gitignoreahora se ha actualizado para Xcode 6.3.2 y Swift, por lo que ahora es correcto. También está documentado.
Eric

Sí, pero el problema de publicar un archivo que destruye datos y mantenerlo así durante meses o años, y aparentemente no molestarse en probarlo adecuadamente, es que sacrificas permanentemente toda la fe, la confianza y el respeto de la comunidad. Demasiado tarde.
Adam

14

Deberías consultar gitignore.io para Objective-C y Swift.

Aquí está el .gitignorearchivo que estoy usando:

# 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

1
siempre usa tu ejemplo. buena configuración! ¡Gracias!
Nikolay Shubenkov

No he usado gitignore.io por un tiempo, vale la pena verificar si no lo has hecho. Puede usarlo para crear un gitignorearchivo para cualquier IDE / idioma, etc. que esté usando. Incluso agregará una sección de cocoapods. Brillante
Ashley Mills

12

Estoy usando AppCode y XCode. Entonces .idea/debe ser ignorado.

agregar esto a Adam .gitignore

####
# AppCode
.idea/

10

Aquí hay un script que hice para crear automáticamente sus archivos .gitignore y .gitattributes usando Xcode ... Lo pirateé junto con algunas cosas de otras personas. ¡Que te diviertas!

Xcode-Git-User-Script

Sin garantías ... Soy un asco en la mayoría de esto, así que úsalo bajo tu propio riesgo


10

Agregar un archivo .gitignore para

Mac OS X + Xcode + Swift

Así es como he agregado un archivo .gitignore en mi proyecto Swift:

  1. Seleccione su proyecto en Xcode y haga clic derecho → Nuevo gruponómbrelo " Git "
  2. Seleccione la carpeta Git y haga clic derecho → Agregar nuevo archivo
  3. Dentro de la pestaña iOS → seleccione Otroarchivo vacío

Ingrese la descripción de la imagen aquí

  1. Dé el nombre del archivo aquí " .gitignore "

Ingrese la descripción de la imagen aquí

  1. Confirme el nombre y tipo de archivo

Ingrese la descripción de la imagen aquí

Aquí está la estructura de resultados:

Ingrese la descripción de la imagen aquí

  1. Abra el archivo y pase el siguiente código

# 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

Bueno, gracias a Adam . Su respuesta me ayudó mucho, pero aún así tuve que agregar algunas entradas más ya que quería un archivo .gitignore para:

Mac OS X + Xcode + Swift

Referencias: esto y esto


1
Muy útil respuesta. Lo agregué como un enlace en mi Configuración de Github en la respuesta Xcode .
Suragch

9

El mío es un .bzrignore, pero es la misma idea :)

.DS_Store
*.mode1v3
*.pbxuser
*.perspectivev3
*.tm_build_errors

El tm_build_errors es para cuando uso TextMate para construir mi proyecto. No es tan completo como Hagelin, pero pensé que valía la pena publicarlo en la línea tm_build_errors.



4

He añadido:

xcuserstate
xcsettings

y coloqué mi archivo .gitignore en la raíz de mi proyecto.

Después de comprometerse y empujar. Entonces corrí:

git rm --cached UserInterfaceState.xcuserstate WorkspaceSettings.xcsettings

enterrado con la carpeta a continuación:

<my_project_name>/<my_project_name>.xcodeproj/project.xcworkspace/xcuserdata/<my_user_name>.xcuserdatad/

Luego ejecuté git commit y presioné nuevamente


¿Lo agregaste también? ¿O es esto todo lo que haces?
Hakre

1
Sí, agregué ambos, pero xcusersate fue el principal archivo ofensivo. Agregar esa era la única forma en que podía empujar mi código de forma remota. De lo contrario, estaba atrapado en un bucle de retroalimentación que requería confirmación antes de presionar. Por lo tanto, se compromete, luego Xcode 4.5 le pedirá que vuelva a hacerlo y nunca podrá presionar porque el requisito previo se está comprometiendo.
user1524957

4

Uso el siguiente archivo .gitignore generado en 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/


2

Aquí está lo .gitignoreque GitHub usa por defecto para los nuevos repositorios de Xcode:

https://github.com/github/gitignore/blob/master/Objective-C.gitignore

Es probable que sea razonablemente correcto en cualquier momento.


El archivo github .gitignore es una colección de todos los archivos con los que tuvimos problemas en el pasado. En este momento, si inicia un proyecto Xcode desde cero y deja que Xcode preconfigure el repositorio git, no queda demasiado para ignorar en .gitignore: lo único que prefiero ignorar es xcuserdata / ... esto ayuda a no saturar sus commits .
código cruzado

GitHub es el primer lugar donde busco gitignores :)
Ben Leggiero

1

La mayoría de las respuestas son de la era Xcode 4-5. Recomiendo un archivo de ignorar en un estilo moderno.

# Xcode Project
**/*.xcodeproj/xcuserdata/
**/*.xcworkspace/xcuserdata/
**/*.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
**/*.xcworkspace/xcshareddata/*.xccheckout
**/*.xcworkspace/xcshareddata/*.xcscmblueprint
.idea/

# Xcode Injection
IOSInjectionProject/
OSXInjectionProject/

# Build
build/
DerivedData

# CocoaPods
Pods/

# fastlane
fastlane/report.xml
fastlane/Preview.html
fastlane/screenshots
fastlane/test_output
fastlane/sign&cert

# CSV
*.orig
.svn

# Other
*~
.DS_Store
*.swp
*.save
._*
*.bak

Manténgalo actualizado desde: https://github.com/BB9z/iOS-Project-Template/blob/master/.gitignore


0

Descubrimos que incluso si agrega .gitignore y .gitattribte, el archivo * .pbxproj puede corromperse. Entonces tenemos un plan simple.

Cada persona que codifica en la oficina simplemente descarta los cambios realizados en este archivo. En el commit simplemente mencionamos los archivos que se agregan a la fuente. Y luego empujar al servidor. Nuestro administrador de integración extrae y ve los detalles de confirmación y agrega los archivos a los recursos.

Una vez que actualice el control remoto, todos tendrán siempre una copia de trabajo. En caso de que falte algo, le informamos que lo agregue y luego tire de nuevo.

Esto nos ha funcionado sin ningún problema.


0

Recomiendo usar Joe para generar un .gitignorearchivo.

Para un proyecto de iOS, ejecute el siguiente comando:

$ joe g osx,xcode > .gitignore

Generará esto .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

-3

Una estructura de un archivo .gitignore standerd para proyecto Xcode>

.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/

¿Cómo es esto diferente a cualquiera de las respuestas anteriores? No solo pegue su gitignorearchivo aquí, esto no agrega nada a este tema.
Ashley Mills

@AshleyMills Lea primero el answar y luego agregue un comentario ... El answar es para una estructura estándar / requerida ... que es esencial tener ...
Rahul Singha Roy
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.