添加自己的pod库的方式:在Podfile中添加pod 'LuaViewSDK', :git => 'git@gitlab.alibaba-inc.com:luaview/LuaViewSDK.git'
自己在开发iOS的时候,经常使用别人的库,通过cocoapods
的pod install
命令就可以很方便的将第三方的框架添加到自己的项目中。
为此,我们如何添加自己的库或者开源框架给别人用呢?下面我将带大家一步步将自己的库发布到cocoapods
上,如果你对cocoapods
还不太了解,那你就太out了。
必备:
- cocoapods命令
- Github帐户
- Mac
一、在Github上创建一个工程。
二、将项目克隆下来,然后再创建一个iOS的项目并放到该目录下。
git clone https://github.com/GeorgeGod/TestPod.git
三、将新建的iOS工程提交到GitHub上。
这里最好能用git打上点,因为我们后面要用上这个打点。
git add -A && git commit -m "Release 1.0.0"
git tag '1.0.0' #这里是增加一个tag打点
git push --tags #push的情况下,默认不上传打点的,所以这里需要将tags上传一下
git push origin master #将代码上传到github上
至此发布pod的准备工作已经做完了,下面开始真正的发布工作了。
四、创建Podspec
文件
在工程的根目录中初始化一个Podspec文件。
pod spec create TestPod
该命令将在本地产生一个名为TestPod.podspec
的文件。我这里用sublime Text 3打开该文件,里面已经有非常丰富的说明文档了。下面介绍如何声明第三方库的代码目录和资源目录,还有第三方库所依赖的iOS核心框架和第三方。这里是我的podspec精简版文件:
Pod::Spec.new do |s|
s.name = "MyChart"
s.version = "1.0.0"
s.summary = "这是我为MyChart创建的一个描述"
s.description = <<-DESC
这是一个object-c的文件...这是一个object-c的文件...这是一个object-c的文件
DESC
s.homepage = "https://github.com/GeorgeGod/PodTest"
s.license = "MIT"
s.author = { "yujiawei" => "1341069918@qq.com" }
s.platform = :ios, "8.0"
s.source = { :git => "https://github.com/GeorgeGod/PodTest.git", :tag => "1.0.0" }
s.source_files = "MyChart/MyChart/*.{h,m}"
# s.exclude_files = "Classes/Exclude"
s.framework = "UIKit"
s.requires_arc = true
# s.dependency "JSONKit", "~> 1.4"
end
解释:
- s.name是我们库的名称
- s.version是库原代码版本号
- s.summary是对我们库的一个简单的介绍
- s.description是需要我们对这个库添加一段描述
- s.homepage声明库的主页
- s.license是所采用的授权版本
- s.author是库的作者
- s.platform是我们库所支持的软件平台,这在我们最后提交进行编译时有用
- s.source声明原代码的地址。我这里是托管在github上,所以这里将地址copy过来就行了。
- s.source_files 声明了我们库的源代码的位置,所以这个地方不能填错了。
对于这里的s.source可以有两种方式,一种是tag,一种是commit。如果用commit的方式的时候,检查TestPod.podspec文件的时候会出现警告,而且也不能发不成功。
tag方式:
:git => "https://github.com/GeorgeGod/PodTest.git", :tag => "1.0.0"
commit方式:
:git => "https://github.com/GeorgeGod/PodTest.git", :commit => "7623791cfc879065202ad84d398f9f5367c7df99"
- s.framework声明了所依赖的核心库,我这里只用到了UIKit,所以是这样的:
s.framework = "UIKit"
如果项目中依赖多个库,可以使用
s.frameworks = "SomeFramework", "AnotherFramework"
当然,我们开发的库中也可能还依赖其他的第三方库,例如JSONKit,那么我们就可以用下面的方式声明:
s.dependency "JSONKit", "~> 1.4"
五、检查Podspec
文件
编辑完podspec文件后,需要验证一下这个文件是否可用,如果有任何WARNING或者ERROR都是不可以的,它就不能被添加到Spec Repo中,不过xcode的WARNING是可以存在的,验证需要执行命令:
pod spec lint PodName.podspec
当看到TestPod passed validation
时,说明验证通过了。
六、 Cocoapods Trunk发布自己的Pods
1. 注册Trunk
pod trunk register 1341069918@qq.com 'yujiawei' --description='Macbook Pro'
这里需要替换成自己的邮箱和用户名,一切顺利的话,会收到一封邮件,点击邮件验证一下即可。
2. 查看自己的Trunk信息
pod trunk me
3. Trunk push
当我们用pod spec lint PodName.podspec
命令检查podspec文件是否有警告和错误后,如果一起正常,我们就可以上传了。
pod trunk push [TestPod.podspec]
到这里我们已经制作完自己的开源库的过程了。以后有新版本只需要修改工程目录下的podspec文件就行了,然后重新执行pod trunk push
命令。
总结
- 开源库发布后需要打上tag。
- 进入根目录下,创建podspec文件
pod spec create PodName
- 编辑podspec文件中的相关信息,有两个比较重要的地方s.source和s.source_files,可以验证是否有误
pod spec lint PodName.podspec
- 注册pod trunk
pod trunk register 1341069918@qq.com 'yujiawei' --description='Macbook Pro'
- 发布到pod trunk
pod trunk push [NAME.podspec]
- 更新pod库
pod setup
如果pod trunk push
成功后,无法pod search
到自己的库。可以执行该命令。如果还搜不到,那就在Podfile
中添加我们创建的库,然后pod install
即可看见我们创建的库了。