流程步骤
注册trunk
想让Cocoapods支持你自己的工具代码库,需要一个CocoaPods账号。
注册命令:
pod trunk register 你的邮箱地址 ‘用户名’ --description='描述信息'
执行以上注册命令后,到你注册邮箱检查一下,会有相关的邮件,点击验证链接打开网页。验证是否成功。
查看注册信息命令:
pod trunk me
至此,我们就注册完CocoaPods账号,可以trunk push我们的自己的代码库。
https://cocoapods.org/
Github上传代码库
需要到Github官网登录你的账户,执行Create a new repository操作。(如果已经有项目,可以直接使用客户端上传,选择LICENSE和README.md)
注意MIT License选项,这个会在添加Cocoapods支持的时候用到。创建完成后,可以通过GitHub Desktop软件或者命令行clone到本地。
可以看到这里的会有一个LICENSE的文件,就是刚刚选着MIT License所创建的。ZHWTools是示例工程,我们要开源的工具类代码库,在示例工程的子文件夹下。
创建podspec配置文件
// podspec文件参考:https://github.com/longitachi/ZLPhotoBrowser/blob/master/ZLPhotoBrowser.podspec
打开终端,在cd到刚刚的文件夹目录下,执行创建podspec命令:(注意podspec对应的是你自己需要开源的库的名称或者库文件夹)
// ZHWtools是你要开源的库名
pod spec create ZHWtools
执行后文件夹里会出现相关的podspec文件,下面需要编辑这个文件,可以在终端执行vim ZHWtools.podspec
进行编辑。也可以用其他的文本编辑器打开,进行编辑。
简单介绍下相关代码行的意义:
s.name:名称,pod search 搜索的关键词,注意这里一定要和.podspec的名称一样,否则报错
s.version:版本号
s.ios.deployment_target:支持的pod最低版本
s.summary: 简介
s.homepage:项目主页地址
s.license:许可证
s.author:作者
s.social_media_url:社交网址,这里我写的微博默认是Twitter,如果你写Twitter的话,你的podspec发布成功后会@你
s.source:项目的地址
s.source_files:需要包含的源文件
s.resources: 资源文件(和podspec同级别)
s.requires_arc: 是否支持ARC
s.dependency:依赖库,不能依赖未发布的库
s.dependency:依赖库,如有多个可以这样写
如果有什么不清楚可以去看一下那么比较知名的开源库(AFNetworking等),参考一下。
需要注意的source_files这个路径的填写,这里也简单说明一下.
这里的路径是相对于.podspec文件的, 如果是与.podspec同级的文件夹, 直接写文件夹名称即可
"*" 表示匹配所有文件
"*.{h,m}" 表示匹配所有以.h和.m结尾的文件
"**" 表示匹配所有子目录
$ git add .
$ git commit -m "0.0.1"
$ git tag 0.0.1
$ git push --tags
$ git push origin master
官方的Podspec Syntax Reference:
https://guides.cocoapods.org/syntax/podspec.html#specification
验证是否可用
执行以下命令进行验证:
pod lib lint ZHWtools.podspec
如果有没有Error输出,只是WARN输出,那么可以将这些警告直接忽略,忽略警告命令。
pod lib lint ZHWtools.podspec --allow-warnings
// 或者按照提示使用
// You can use the `--no-clean` option to inspect any issue.
pod lib lint ZHWtools.podspec --no-clean
// 如果报错,可以在解决问题后, 删除原来的 tag ,重新打标记
git tag -d 0.0.1 //删除本地tag
git push origin :refs/tags/0.0.1 // 删除远程库tag
// 验证通过后, push 到 CocoaPods
pod trunk push NYHEmptyView.podspec
当终端输出ZHWtools passed validation
之后,就说明验证通过了。
这两条命令是为pod添加版本号并打上新的 tag:
set the new version to 1.0.1
set the new tag to 1.0.1
trunk push 代码到 CocoaPods
所有的准备工作都已经完成了,下面就需要将我们编写的文件push到Cocoapods。
执行以下命令:
pod trunk push ZHWtools.podspec
检验是否上传成功命令:
pod search ZHWtools
如果搜索不到,建议删除本地的CocoaPods的搜索目录,执行以下命令:
rm ~/Library/Caches/CocoaPods/search_index.json
再重新执行pod search ZHWtools
命令搜索就可以看到,我们的开源的工具代码库的相关信息,可以通过pod 命令安装到工程中使用。
ps:如果你发布成功后,在你自己的电脑上可以search到,在别的电脑上搜不到,建议执行rm ~/Library/Caches/CocoaPods/search_index.json
命令,先删除旧的搜索目录。也可以尝试更新你的pod。
// 参考:
https://stackoverflow.com/questions/23900688/cocoapods-trunk-cannot-push-update-you-need-to-register-a-session-first
https://cocoapods.org/
https://www.jianshu.com/p/f146fa5358d5?mType=Group
https://www.cnblogs.com/zhanglinfeng/p/6283178.html
http://yulingtianxia.com/blog/2014/05/26/publish-your-pods-on-cocoapods-with-trunk/
// Github 开源许可证 介绍
https://choosealicense.com/
// 最新参考:
https://www.jicanshu.com/p/a5a73f0cabb1
https://www.jianshu.com/p/a72a529dc659
https://www.jianshu.com/p/d9da8bfa5a53
https://www.colabug.com/4743362.html
// CocoaPods 错误总结:
https://www.jianshu.com/p/283584683b0b
项目添加 CocoaPods 支持注意事项:
1.库文件问题(指定开源的库),资源文件也需要指定对用路径
2.生成 podspec 文件问题,这个文件最好是你开源的库名称相同但是也可以不同(相对于 podspec 文件开始计算路径)
3.第三方库依赖问题(如果依赖第三方库,该如何处理)
4.git 命令行
通过命令行把项目上传到 github
1、cd *项目所在根目录*
2、git init
3、git add . *点的意思是添加目录下的所有文件,也可以写某个添加的某个文件名*
4、git commit -m "注释内容"
5、在GitHub上create new repository,并copy链接
6、git remote add origin *这里写上一步copy的链接*
7、回车之后,如果提示:remote origin already exists,
请输入:git remote rm origin之后重新执行第6步。
(如果没有错误,请忽略这一步)
8、上传之前先 pull 一下, git pull origin master
9、git push -u origin master
10、刷新GitHub,项目已经上传成功。
给项目打标记
git tag "0.0.1"
git push --tags
git push origin master
删除标记
git tag -d 0.0.1 // 删除本地tag
git push origin :refs/tags/0.0.1 // 删除远程库tag
验证 podspec 文件是否合法:
pod lib lint NYHEmptyView.podspec
Push 到 CocoaPods:
pod trunk push NYHEmptyView.podspec