这篇文章详细的讲解如何发布自己的开源框架到Cocoapods,比较基础,如有错误,欢迎指正。
要点:
- pod的版本依赖于Git的tag,将一个tag视为工程的一次release
- 一个pod版本对应一个tag,pod版本最好与tag一致
- pod 命令可以使用--verbose 开启啰嗦模式查看日志
一、创建github repository
- 项目名称:自己填写项目名称,最好是自己想发布的库的名称,方便管理
- 项目描述:可选项,描述当前项目
- 公开项目:选择public别人才能看到和下载这个库,创建私有库需要$$
- README:一个好的项目需要一个README文件来介绍库文件如何使用
- .gitignore: Git管理项目的忽略文件,一般选择对应语言即可,对其修改为Git管理知识,这里不做铺开
- 开源许可证:开源许可证,根据自己的需要设置,我选择MITcocoapods对开源许可设置比较在意,所以需要设置一个
二、克隆项目到本地
-
在github上找到项目的地址
- 克隆项目到本地
$ git clone git@github.com:read0nly/DemoKit.git
-
将写好的开源库源代码放入本地的Git仓库下
三、注册pod trunk
要将一个开源库或者私有库发布到pods之前你需要注册trunk
pod trunk register [email] '[name]' --description='[desc]'
- email:任意邮箱,推荐使用你注册github的邮箱
- name:推荐使用github的name
- desc:简单的描述信息
例如我自己注册一个:
pod trunk register nj.readonly@gmail.com 'read0nly' --description='macbook pro'
注册之后需要进入上面填的邮箱,点击链接进行邮箱验证 </br>
完成之后可以使用pod trunk me检测是否注册成功
pod trunk me
注册成功后将看到如下信息:
$ pod trunk me </br>
- Name: read0nly</br>
- Email: nj.readonly@gmail.com</br>
- Since: April 12th, 08:49</br>
- Sessions:</br>
- April 12th, 08:49 - August 19th, 19:56. IP: 167.99.173.25
四、发布pod
1.创建.podspec
$ pod spec create [name]
- name: podspec 文件的名称,一般与git上创建的repository名称相同</br>
// 如:</br>
pod spec create DemoKit
执行此命令事实上是在当前目录创建了一个.podspec文件(纯文本文件),这个文件记录了pod发布执行的动作,以及资源配置信息。
2.修改.podspec文件
.podspec文件生成之后里面有一个模板,有很多的注释和配置,比较全面,但是有些内容可能是我们目前使用不到的。这里提供一个简洁版的.podspec文件,如果后续有其他需求,例如子模块之类的,可以再自行添加。
Pod::Spec.new do |s|
s.name = "DemoKit"
s.version = "0.0.1"
s.summary = "A demo for cocoapods."
s.homepage = "https://github.com/read0nly/DemoKit"
s.license = { :type => "MIT", :file => "LICENSE" }
s.author = { "nj" => "nj.readonly@gmail.com" }
s.platform = :ios, "8.0"
s.source = { :git => "https://github.com/read0nly/DemoKit.git", :tag => s.version.to_s }
s.requires_arc = true
s.source_files = "DemoKit/*"
#s.exclude_files = ""
s.framework = "UIKit","Foundation"
s.swift_version = "4.0"
end
- name:pod库的名字
- version:版本号
- summary:总结
- homepage :主页,项目在github上的主页
- license :开源证书,type为类型,file是文件,注意文件路径,如果.podspec在同一目录下,可以不写路径
- author :作者,包含名字和联系方式
- platform:支持的平台,这里支持iOS8,也可以支持OSX,tvOS,watchOS等
- source:项目源,写自己项目在github上的地址,要发布的版本建议与pod版本一致
- requires_arc:是否支持arc
- source_files:要包含的文件,/*代表包含这个目录下面的所有文件,也可匹配某一个类型的文件,例如:DemoKit/**/*.siwft 或者 DemoKit/**/*.{h,m}分别代表DemoKit下所有目录的swift 或.h .m文件
- exclude_files:不包含的文件,规则同上,如果在包含文件里面没有需要排除的文件,则删除此行
-
framework:依赖的系统库
- swift_version:swift版本,对于swift项目来说这个参数很重要,一定要填写库文件所使用的swift版本,否则会导致编译失败
其他的配置信息,需要的时候可以到Cocoapods项目官方文档podspec部分查阅
3.检验.podspec文件
修改完.podspec文件之后,我们使用lint命令进行本地测试
pod lib lint
可以使用 --verbose 参数开启啰嗦模式,可以查看详细日志信息
pod lib lint --verbose
如果有错误,可以根据错误提示解决错误,文章最后部分列举了几种错误解决方式。如果有警告可以不用管,也可尝试解决
4.将库文件打上tag,push到github
- 查看没有提交的文件
git status -s
- 添加所有文件
git add .
- 提交文件
git commit -m 'commit version 0.0.1'
使用-m参数添加提交时候的日志信息,一定要填
- push 代码到github
git push
- 打上标签 tag
git tag '0.0.1'
cocoapods发布依赖与标签tag,前面.podspec文件里面的版本正是每一个tag的版本,建议tag与需要发布的版本相同
- push tag到github
git push --tag
5.push到cocoapods
使用push命令,发布自己的版本库到cocoapods
pod trunk push DemoKit.podspec
如果有警告可以使用--allow-warnings选项允许警告
pod trunk push DemoKit.podspec --allow-warnings
如果依赖了第三方库,需要加上 --use-libraries 选项
发布成功之后可以看到如下信息:
6.查看自己的pod库
提交成功几分钟之后就可以使用pod search DemoKit 来查看自己的库了
pod search DemoKit
如果查询不到,可以尝试初始化,或者更新本地的spec
pod repo init
pod repo update
如果还是查询不到,可以删除本地的pod索引文件
sudo rm ~/Library/Caches/CocoaPods/search_index.json
删除之后再重新执行pod search
五、lint 错误
<span id = 'lint_issuse' ></span>
NO.1
- ERROR | [iOS] unknown: Encountered an unknown error (The 'Pods-App' target has transitive dependencies that include static binaries: (/private/var/folders/m7/7t1r7_993fbgs40fppwxrsm80000gn/T/CocoaPods-Lint-20180301-60100-1meifl-Payment/Pods/openssl-ios-bitcode/lib/libcrypto.a and /private/var/folders/m7/7t1r7_993fbgs40fppwxrsm80000gn/T/CocoaPods-Lint-20180301-60100-1meifl-Payment/Pods/openssl-ios-bitcode/lib/libssl.a)) during validation.
依赖了其他库,添加--use-libraries选项
$ pod lib lint --use-libraries
NO.2
xcodebuild: error: Unable to find a destination matching the provided destination specifier:
{ id:6AC7A44D-6523-4371-AAAB-C5191451D58E }
Available destinations for the "App" scheme:
{ platform:iOS Simulator, id:9C15AC46-816E-4A85-9F21-A693CE34D542, OS:11.2, name:iPhone SE }
{ platform:iOS Simulator, id:626866A7-B843-4CCF-B27D-00420F5F16DB, OS:11.2, name:iPhone X }
Ineligible destinations for the "App" scheme:
{ platform:iOS, id:dvtdevice-DVTiPhonePlaceholder-iphoneos:placeholder, name:Generic iOS Device }
{ platform:iOS Simulator, id:dvtdevice-DVTiOSDeviceSimulatorPlaceholder-iphonesimulator:placeholder, name:Generic iOS Simulator Device }
Testing with xcodebuild.
这个问题困扰了我很久,我是在查看cocoapods的issues#7454中才找了解决方案。问题原因由于本地模拟器设置,在“Generic iOS Device”设备下无法通过编译。目前暂行解决方式是在Xcode -> Window -> Devices & simulators 里面删除模拟器,直到剩下错误信息中“Available destinations”下的设备,或者lint检验通过。
遇到问题,可以查看错误日志,或者查看Cocoapods的issues来解决问题。