让你的git库支持cocoapods

ps:要让一个git库支持cocoapods,大致需要这几步:
  1. 创建git库、添加.gitignore、README、LICENSE (LICENSE必须要有、其他可选、建议加上)
  2. 添加.podspec/编辑.podspec (最最最重要的一点)
  3. 添加tag、验证.podspec (cocoapods依赖tag所以必须打tag、第三点编辑不对验证.podspec会报各种错误)
  4. 注册cocoapods
  5. 发布 (如果没有意外、到这里就大功告成了)

废话不多说,直接上干货!!!

1. 创建git库

如何使用git库这里不多赘述,git平台不是唯一的,这里以github为例
在创建git库的时候,.gitignore、README、LICENSE这些都是可以自动生成的,不用过多在意,值得提一点的是:生成LICENSE的时候选择MIT就行了

2. 创建.podspec

首先cd到你的git库的根目录下
这里需要使用指令 -pod spec create MyProject 之后会得到一个文件MyProject.podspec
或者你也可以找别人写好的.podspec文件拿过来直接修改也可以
注意:MyProject是你git库的名字,MyProject.podspec这个文件名需要和你的git名字一致

3. 编辑.podspec

打开创建好的.podspec文件,删除注释, 前面有#的为注释, 如果你想知道每个东西的含义也可以了解一下

Pod::Spec.new do |s|

  s.name         = "MyProject"
  s.version      = "0.0.1"
  s.summary      = "A helpful category."

  s.description  = "A description of HelpfulCategory."

  s.homepage     = "https://github.com/My/MyProject"

  s.license      = "MIT"
  # s.license    = { :type => "MIT", :file => "FILE_LICENSE" }

  s.author       = { "Chenzuliang" => "chenzuliang@geek-zoo.com" }
  s.requires_arc = true

  s.platform     = :ios, "7.0"
  s.ios.deployment_target = "7.0"

  # s.frameworks = "UIKit", "Foundation", "CoreGraphics"
  # s.library = "sys"

  s.source       = { :git => "https://github.com/My/MyProject.git", :tag => s.version }

  s.source_files  = "MyProject/**/*.{h,m}"
  # s.exclude_files = "MyProject/**/*.{h,m}"
end

接下来讲解一下每行代码的含义:

  • s.name:名称,pod search 搜索的关键词,注意这里一定要和.podspec的名称一样,否则报错
  • s.version:版本号
  • s.ios.deployment_target: 支持的pod最低版本
  • s.summary: 简介
  • s.homepage: 项目主页地址
  • s.license: 许可证
  • s.author: 作者
  • s.social_media_url: 社交网址
  • s.source: 项目的地址
  • s.source_files: 需要包含的源文件,写法及含义建议大家写第一种或者第二种
    1. "MyProject/*"
    2. "MyProject/yoowei/*.{h,m}"
    3. "MyProject/** /*.h"
      • “*” 表示匹配所有文件
      • “*.{h,m}” 表示匹配所有以.h和.m结尾的文件
      • “**” 表示匹配所有子目录
  • s.resources: 资源文件
  • s.requires_arc: 是否支持ARC
  • s.dependency:依赖库,不能依赖未发布的库
  • s.dependency:依赖库,如有多个可以这样写

另外:

  1. 引用静态库: "(.ios).library"。去掉头尾的lib,用","分割。 注意: (.ios)括号括起来代表可以省略:

    例如: 引用 libxml2.lib 和 libz.lib.
    s.libraries = 'xml2', 'z'

  2. 引用公有framework: "(.ios).framework" 用","分割. 去掉尾部的".framework"
    s.frameworks = 'UIKit','SystemConfiguration', 'Accelerate'

  3. 引用自己生成的framework: "(.ios).vendored_frameworks" 用","分割 路径写从.podspec所在目录为根目录的相对路径

    ps: 这个不要省略.framework s.ios.vendored_frameworks = 'Pod/Assets/*.framework'

  4. 引用自己生成的.a文件, 添加到Pod/Assets文件夹里. Demo的Example文件夹里也需要添加一下, 不然找不到
    spec.ios.vendored_libraries = 'Pod/Assets/*.a'

注意:在提交到私有仓库的时候需要加上--use-libraries

ps: 更多的可以参考其他成熟的开源库的.podspec文件的编写

4. 创建LICENSE(许可证/授权)文件,此文件必须要有

创建一个文件名字命名为LICENSE,内容如下:

MIT LicenseCopyright (c) 2017Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

只需要把前面的版权改一下就行了, 后面的都一样

ps: 一般我们创建仓库的时候,大多数已经创建好了的

5. 上传git、打tag

将包含配置好的 .podspec, LICENSE 的项目提交 Git仓库, 然后打上tag。

因为cocoapods是依赖tag版本的, 所以必须打tag。以后每次更新只需要把你的项目打一个tag,然后修改.podspec文件中的版本号,接着提交到cocoapods官方就可以了。

注意: 一定将tag提交到远程仓库,这一步很重要

6. 验证.podspec

前面的步骤通常都很顺利,到这里一般就开始踩坑了,如果你前面编写.podspec时出错了,这里是验证不过的,但好在通常错误信息都比较明显,照着改就好了

执行-pod spec lint MyProject.podspec --verbose
成功后会提示MyProject passed validation.

前段时间操作遇到的错误和警告:

警告可以--allow-warnings忽略掉,但error必须解决

遇到错误:

- ERROR | name: The name of the spec should match the name of the file.

// 这个是要保证.podspe文件的名称和里面s.name保持一致

- ERROR | [iOS] xcodebuild: Returned an unsuccessful exit code. You can use '--verbose' for more information.

// 这个当时困惑了我好久,查了好多资料,很多原因都会报着个错,我这里是多引用了framework, 注释掉这个解决的s.frameworks = "UIKit", "Foundation", "CoreGraphics"

7. 注册Trunk

如果要添加到Cocoapods的官方库了,可以使用trunk工具,具体可以查看官方文档。如果是私有库的话,详情参考这里

trunk需要CocoaPods 0.33版本以上,用pod --version 命令查看版本,如果CocoaPods版本低,需要升级。已经注册过的不需要注册,查看自己有没有注册-pod trunk me

- Name:     xxx
- Email:    xxx@163.com
- Since:    January 12th, 04:38 
- Pods:     None 
- Sessions:    - January 12th, 04:38 - May 21st, 03:35. IP: 218.205.57.27

看到这个就说明你已经注册过了,如果没有注册的话 [!] You need to register a session first.

注册:pod trunk register xxx@163.com "xxx" --verbose

[!] Please verify the session by clicking the link in the verification email that has been sent to xxx@163.com
注册完成之后会给你的邮箱发个邮件,进入邮箱邮件里面有个链接,需要点击确认一下。

更新cocoapods版本

-sudo gem install cocoapods -n /usr/local/bin

注意:如果上面这句指令不加 -n/usr/local/bin 可能会报错:

ERROR:  While executing gem ... (Errno::EPERM)
    Operation not permitted - /usr/bin/pod

9. 发布

发布时会验证 Pod 的有效性,如果你在手动验证 Pod 时使用了 --use-libraries 或 --allow-warnings 等修饰符,那么发布的时候也应该使用相同的字段修饰,否则出现相同的报错。

-pod trunk push MyProject.podspec
// --use-libraries --allow-warnings
// -pod lib lint --allow-warnings 
// -pod lib lint --use-libraries

成功了之后会出现以下内容:

--------------------------------------------------------------------------------
 🎉  Congrats

 🚀  HelpfulCategory (0.0.3) successfully published
 📅  May 10th, 23:56
 🌎  https://cocoapods.org/pods/HelpfulCategory
 👍  Tell your friends!
--------------------------------------------------------------------------------

之后你就可以-pod search MyProject搜索到你的git库了, 提示:可能会有一点延迟,如果一切成功,还搜索不到的话稍后再搜就可以了

但是:这里我遇到问题了,很久时间过去了,pod search依然找不到,开始各种尝试,最终发现,是因为我pod setup成功后会生成~/Library/Caches/CocoaPods/search_index.json文件。而问题就在这里。

rm ~/Library/Caches/CocoaPods/search_index.json
删除这个文件再次pod search
Creating search index for spec repo 'master'.. Done!成功了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容