iOS Git仓库中.gitignore配置

1.创建gitignore文件

打开终端(terminal或者iTerm)。

 输入命令cd 项目目录进入本地代码仓库目录。

 输入命令ls查看是否已经存在该文件。

 输入命令touch .gitignore可创建该文件。

 输入命令open .gitignore可打开该文件,进行编辑。

==注意事项:==

 如果当前Mac系统环境下,没有显示.gitignore,.cocoapods等类型的文件的话,需要执行相关的命令可解决该问题。

 示隐藏文件的命令:defaults write com.apple.finder AppleShowAllFiles -bool true

 关闭显示隐藏文件的命令:defaults write com.apple.finder AppleShowAllFiles -bool false

2.gitignore语法规范

 1、空行或是以#开头的行即注释行将被忽略。

 2、使用 正斜杠/来避免递归跟踪。

 3、使用 正斜杠/来忽略文件夹,例如 build/ 即忽略 build 文件夹,/doc/build/ 这样的目录也会忽略。

 4、使用!来否定忽略,即比如在前面用了*.ipa,然后使用!appName.ipa,则这个appName.ipa文件不会被忽略。

 5、*用来匹配零个或多个字符,如*.[oa]忽略所有以.o.a结尾。

 6、[]用来匹配括号内的任一字符,如[abc],也可以在括号内加连接符,如[0-9] 匹配0至9的数;

 7、?用来匹配单个字符。

示例:


#DS_Store是mac系统中管理文件夹位置信息的文件

#忽略当前目录下的.DS_Store文件

.DS_Store

#忽略当前目录下所有子目录下的.DS_Store文件

*/.DS_Store

# 忽略 .a 文件

*.a

# 但否定忽略 lib.a, 尽管已经在前面忽略了 .a 文件

!lib.a

# 仅在当前目录下忽略 TODO 文件, 但不包括子目录下的 subdir/TODO

/TODO

# 忽略 build/ 文件夹下的所有文件,/doc/build/ 这样的目录也会忽略

build/

# 忽略 doc/notes.txt, 不包括 doc/server/arch.txt

doc/*.txt

# 忽略所有的 .pdf 文件 在 doc/ directory 下的

doc/**/*.pdf

3.配置gitignore时可能遇到的问题

 git的使用过程中,有很多文件是不需要被提交到版本库中的,比如我们这次提到的.DS_Store文件。

.DS_Store文件在Mac系统中是管理文件夹的位置信息文件,没有必要上传到git仓库中,可以在.gitignore文件添加.DS_Store这一项配置来忽略此类文件。

 但是如果项目之前没有配置过.gitignore文件,如果直接在.gitignore文件添加.DS_Store忽略此类文件会无法生效。因为远端仓库中之前已经生成了对该类文件的进行追踪的缓存,需要先删除远端的仓库的中对.DS_Store文件的追踪。

 进入到项目目录下执行一些命令


git rm --cached .DS_Store

 该命令会把.DS_Store从git的索引库中移除,但对文件.DS_Store本身并不进行任何操作,也就是说本地还是有.DS_Store文件的,只是远端却没有了。

 同时也需要我们在新建的.gitgnore文件里忽略掉.DS_Store文件,然后提交修改到远端仓库。

==问题:==

.gitignore文件已经配置过,并上传到远端仓库,但是设置的忽略没有生效。

==原因:==

 由于git缓存的问题,.gitignore只能忽略那些原来没有被追踪的文件,如果某些文件已经被纳入了版本管理中,则修改.gitignore是无效的。

==解决方法==

 先把本地缓存删除(改变成未被追踪状态),再重新添加(此时会读取.gitignore的配置进行忽略),最后再提交到远端仓库。

首先,更新缓存,运行如下命令:


git rm -r --cached .

git add .

git commit -m 'update .gitignore'

4.iOS Git仓库.gitignore的配置

 项目中.gitignore配置参考示例


# Created by https://www.gitignore.io/api/objective-c

# Edit at https://www.gitignore.io/?templates=objective-c

### Objective-C ###

# Xcode

#

# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore

## OS X

#

#DS_Store是mac系统中管理文件夹位置信息的文件

.DS_Store

*/.DS_Store

## vim or gvim每次写完代码的时候,项目中会多出很多*.swp文件

*.swp

## Build generated(编译时产生的文件)

build/

DerivedData/

## Various settings(其他设置)

*.pbxuser

!default.pbxuser

*.mode1v3

!default.mode1v3

*.mode2v3

!default.mode2v3

*.perspectivev3

!default.perspectivev3

xcuserdata/

## Other

*.moved-aside

*.xccheckout

*.xcscmblueprint

## Obj-C/Swift specific

*.hmap

*.ipa

*.dSYM.zip

*.dSYM

# 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(类似于CocoaPods的管理第三方的工具)

#

# 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 repo. Instead, use fastlane to re-generate the

# screenshots whenever they are needed.

# For more information about the recommended setup visit:

# https://docs.fastlane.tools/best-practices/source-control/#source-control

fastlane/report.xml

fastlane/Preview.html

fastlane/screenshots/**/*.png

fastlane/test_output

# Code Injection(Xcode上的一个插件)

#

# After new code Injection tools there's a generated folder /iOSInjectionProject

# https://github.com/johnno1962/injectionforxcode

iOSInjectionProject/

### Objective-C Patch ###

# End of https://www.gitignore.io/api/objective-c

其他参考:

gitignore.io

该网站可以自定义不同开发语言的.gitignore文件配置,输入你需要配置的语言,会帮助你自动生成一份配置。比如,输入Objective-C和Swift会帮助你生成配置。

Github gitignore

也可去GitHub中下载.gitignore文件,可以选择Objective-C.gitignore或者Swift-C.gitignore进行参考。

你可能感兴趣的:(iOS Git仓库中.gitignore配置)