如何发布开源自己的框架或类库到CocoaPods - 图文讲解

当自己的库已经上传GitHub后,那么如何快速简单的开源自己的库呢?

这里就是介绍如何将自己的类库上传到pods管理库,以便开源所有人都能方便使用。

 

准备前提:

- 项目已上传到GitHub (注意,这里不唯一,其他开源平台网站也可)。

- 这里以我之前的一个项目作为示例。(SwiftPopMenu)

 

步骤如下:

- 创建.podspec

- 项目打 tag

- 验证有效性

- 注册CocoaPods

- 发布

 

 

================================== start =================================

 

1、生成.podspec文件,这个是pod的描述文件,很重要

//SwiftPopMenu 是你的框架名称
pod spec create SwiftPopMenu

  

执行后会看到当前目录下会出现一个SwiftPopMenu.podspec文件,用编辑器打开(可用vim,我用的Sublime Text,比较好用一点),会看到很多注释,根据自己的项目修改编辑,得到类似下面的内容:  

 

Pod::Spec.new do |s|

  s.name         = "SwiftPopMenu"
  s.version      = "1.0.0"
  s.summary      = "easy use SwiftPopMenu on iOS"
  s.description  = "easy use SwiftPopMenu on iOS,use by readme"

  s.homepage     = "https://github.com/TangledHusky/SwiftPopMenu"

  s.license      = { :type => "MIT", :file => "LICENSE" }
  s.author             = { "TangledHusky" => "your email,eg:xxx@qq.com" }
  s.platform     = :ios, "8.0"
  s.source       = { :git => "https://github.com/TangledHusky/SwiftPopMenu.git", :tag => "v#{s.version}" }
  s.source_files  = "SwiftPopMenu/*.{swift}"

end

 

 

 

这里的选项是删除过后的,原文是有很多注释的,为了可读性,可以删除掉。

如果有依赖型或资源文件,要加上这些:

s.dependency "MBProgressHUD" 
s.resources = "YJProgressHUDK/*.bundle"

 

这里我遇到几个坑:

(1)s.summary和s.description 内容不能一样,否则会warning,导致后面验证不通过。

(2)s.source的tag不用改,保持tag => "v#{s.version}" 即可。

(3)s.source_files的路径是里库文件夹下的所有文件,所以要定位到那一层路径,这里我用的swift,所以后缀是.{swift},如果是oc,这里是.{h,m}

 

2、因为cocoapods是依赖tag版本的,所以必须打tag。

PS:以后如果有新版本需要再次更新的话,只需要把你的项目打一个tag,然后修改.podspec文件中的版本接着提交到cocoapods官方就可以了,提交命令请看下面

cd进入本地项目目录,进去后输入如下:

git tag 'v1.0.0'

git push --tags

注意这里版本号加“v”,不然后面会有坑。

 

3、接着 把修改好的文件push到github上去   

(如果用SourceTree等可视化工具,可忽略命令,直接在工具上push执行)

git add SwiftPopMenu.podspec

git commit -am "add SwiftPopMenu.podspec file”

git push -u origin master

  

4、但是!! 以上做完之后,使用pod search 是搜不到你的库的,因为这只是你私有本地库。

要想使用Trunk服务,首先你需要注册自己的电脑。

已注册或不确定是否注册:

查看自己有没有注册

pod trunk me

  

注册:

只要指明你的邮箱地址(spec文件中的)和名称即可。

pod trunk register 123456@qq.com 'github账户名' --description='macbook air'

然后顺利的话你会收到一份邮件,需要点击验证。 

 

然后,再次使用

pod trunk me

查看自己的注册信息

  

5、上面的工作完成之后,我们就可以开始 trunk push 了提交我们的podspec文件。

pod trunk push 命令会首先验证你本地的podspec文件(是否有错误),之后会上传spec文件到trunk,最后会将你上传的podspec文件转换为需要的json文件 
第一步验证podspec文件:

pod spec lint SwiftPopMenu.podspec

如果验证成功的话会显示

 

当然,这一步很容易会error,但是,都会列出你哪里的问题,照着改就是了,最常见的可能就是:

warning: Could not find remote branch v1.0.0 to clone.

fatal: Remote branch v1.0.0 not found in upstream origin

 这里就是因为之前git tag 没加v,修改并重新提交下再试一下。

当然,有时间有这样一种情况:会报warning错误,如果是不影响功能或偷懒不想改,可以绕过:

pod spec lint --allow-warnings SwiftPopMenu.podspec

这样就可以通过验证了。

 

 

最后,输入下面命令进行提交发布:

pod trunk push SwiftPopMenu.podspec

如果上面验证用了 --allow-warnings ,这里也需要这样做:

pod trunk push --allow-warnings SwiftPopMenu.podspec

 

  

如果发布成功,就会看到:

 

注意:

执行上面的push操作,就相当于你把你的源代码提交给CocoaPods团队审核了,一般需要一到两个工作日可以审核结束。

下面就是安心等待了。。。(网上的说法)

 

 6、如果收到了cocoapods官方发过来的审核通过邮件后(不知道为啥,我没收到邮件😂),这时,我们用pod search  是搜不到的,原因就是我们本地的~/.cocoapods/repos/master/Specs,还没跟官方的github上的Specs同步, 

执行一次:

pod setup

  或

pod update

 

来更新本地缓存的Spec库,再去search就能看到了

 

如果还是不行,没关系

先清空本地缓存,

sudo rm -fr ~/Library/Caches/CocoaPods/

再重新setup

pod setup

 

 

然后我们就可以自由使用啦!

 

===================后续 更新库  篇============================= 

下次库有了改动,需要发布新版本时:

1、修改源码,并push到github

2、修改podspec文件并push,修改version即可。

3、cd到项目路径(spec根目录)

比如:

打tag:

git tag 'v1.x.x'

git push --tags

验证:

pod spec lint SwiftPopMenu.podspec

提交发布:

pod trunk push SwiftPopMenu.podspec

 

(上面都有命令,可直接拷贝)

 

如果遇到错:

[!] Authentication token is invalid or unverified. Either verify it with the email that was sent or register a new session.

分析解决:

这个错误是因为你没有打开邮箱中发给你的网址,如果想重新发送请执行下面代码(xxx表示你的github名称)

pod trunk register XXX@163.com XXXX

发送完,点击邮箱验证,重新发起提交就可以了

 

posted @ 2016-12-10 12:59  那一抹风情  阅读(632)  评论(0编辑  收藏  举报