Github上的代码添加Cocoapods支持
一、前言
快速让自己Github上的库成功支持Cocoapods安装支持。
二、开始
这里我将从最初的开始进行介绍,包括Github上创建项目已经上传项目,到最后的支持Cocoapods。 步骤如下:
- 代码上传Github
- 创建podspec文件,并验证是否通过
- 在Github上创建release版本
- 注册CocoaPods账号
- 上传代码到CocoaPods
- 检查上传是否成功
- 常见问题汇总
1、代码上传Github
首先我们打开github.com,然后创建自己的项目工程:
这里注意那个MIT License,在后面添加Cocoapods支持的时候会用到(稍后介绍)。然后点击创建即可。(如果是已有项目,创建的时候没有选择MIT,查看本文最后的可能遇到的问题。) 然后将代码clone到本地,将自己的项目放到里面,文件夹如图所示:
这里的LICENSE就是刚才说的MIT License添加的文件。 GPCountDownDemo是示例工程 GPCountDown就是提供给他人使用的库。
然后提交到Github就可以了。
2、创建podspec文件,并验证是否通过
我们使用终端到工程目录下,然后执行下面的命令:
pod spec create GPCountDown
这里的GPCountDown就是pod添加的名字(例如:SDWebImage)。执行完后的结果:
此时在工程文件夹下也会多一个GPCountDown.podspec文件。这里我用Sublime Text打开并做了如下编辑:
这里字段介绍如下:
name:库的名称
version:版本
summary:介绍语
description:描述
homepage:Github上项目地址
license:许可证
author:作者
source:项目的https链接地址
source_files:要共享的代码,这里是GPCountDown下面的所有代码。
platform:运行平台
接下来执行下面的命令进行验证:(–allow-warnings 忽略警告)
pod lib lint GPCountDown.podspec --allow-warnings
结果多种多样,如果有错,则按照提示进行改错即可。在这里,我执行的结果如下图:
当看到GPCountDown passed validation之后,就说明验证通过了。
3、在Github上创建release版本
打开项目的目录,然后创建release版本的类库:
点击 箭头指向开始创建release版本,(点击 Create a new release):
点击Publish release即可。创建完成后如图所示:
这样第三步就完成了
4、注册CocoaPods账号
执行命令行:
pod trunk register 邮箱地址 ‘用户名’
执行完之后结果如下:
黄色提示已经发送了一个验证码到邮箱,你可以打开你的邮箱验证即可。打开邮件中的链接后如下:
这样就成功注册了Cocoapods账号。 可以用
pod trunk me
检查是否创建成功。成功的结果如下:
5、上传代码到CocoaPods
首先检测文件格式的有效性:(警告,可以使用 –allow-warnings忽略)
pod spec lint --allow-warnings
出现passed validation就说明通过验证了。然后执行:
pod trunk push GPCountDown.podspec --allow-warnings
执行结果如下:(速度应该有点慢) 说明了已经上传成功。
6、 检查上传是否成功
pod search ZGRSAEncryptor
结果如下:
ok,已经成功了。这样就可以让其他人进行搜索使用了。
7、常见问题
一、开源代码忘记生成MIT协议LICENSE ,后续如何添加?
1.打开在GitHub上的项目,选择Creat new file
2.填入创建的类型为LICENSE,点击右侧按钮
3.进入到现在这个页面时,选择开源协议MIT,点击Review and submit 按钮
4.提交文件Commit new file即可 (提交按钮上有两个选项,第一个是直接提交此次修改,第二个是发一个merger Request ,达到的效果是一样的,第二个有合并记录,麻烦一点)
5.大功告成,看如图,就可以愉快的进行代码分享了
二、上传成功了但是搜索不到 使用下面的指令来清理一下缓存:
rm ~/Library/Caches/CocoaPods/search_index.json