利用cocoapods管理开源项目,支持 pod install安装整个流程记录(github公有库),完成预期的任务,大致有下面几步:
1.代码提交到github平台
2.创建.podspec
3.编辑.podspec
4.添加tag
5.验证
6.注册CocoaPods
7.发布
详细流程如下:
1.代码提交到github平台
将自己的代码上传到github上面(不是唯一的,上传到任何平台上都可以,前提是项目是开源的)。至于怎么利用github管理我们的项目,可以参考:http://www.cnblogs.com/richard-youth/p/4684100.html
2.创建.podspec
首先要利用cocoapods将项目管理起来,具体可以参考:http://www.cnblogs.com/richard-youth/p/4508049.html注
yooweiTest这个是你框架的名称)
$ pod spec create
yooweiTest
3.编辑.podspec
创建好后打开,删除注释, 前面有#的为注释,如果你想知道每个东西的含义可以了解一下
整理之后的文件Pod::Spec.new do |s|
s.name = "
yooweiTest"
s.version = "1.0"
s.ios.deployment_target = '7.0'
s.summary = "
yooweiTest"
s.homepage = "
https://github.com/yoowei/yooweiTest"
s.license= { :type => "MIT", :file => "LICENSE" }
s.author = { "yoowei" => "yoowei@126.com" }
s.source = { :git => "
https://github.com/yoowei/yooweiTest.git", :tag => s.version } /注意需要
.git结尾。
s.source_files = "yooweitest", "yooweitest/**/*" //需要和.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:社交网址
s.source:项目的地址
s.source_files:需要包含的源文件
s.resources: 资源文件
s.requires_arc: 是否支持ARC
s.dependency:依赖库,不能依赖未发布的库
s.dependency:依赖库,如有多个可以这样写
s.license= { :type => "MIT", :file => "LICENSE" }
这里建议大家这样写,如果写别的会报警告,导致后面一直提交失败
- source_files:写法及含义
建议
大家写第一种或者第二种"yooweitest/* "yooweitest/yoowei/*.{h,m}" "yooweitest/**/*.h"
- “*” 表示匹配所有文件
- “*.{h,m}” 表示匹配所有以.h和.m结尾的文件
- “**” 表示匹配所有子目录
- s.source 常见写法
s.source = { :git => "https://github.com/yoowei/yooweiTest.git", :commit => "68defea" } s.source = { :git => "https://github.com/yoowei/yooweiTest.git", :tag => 1.0.0 } s.source = { :git => "https://github.com/yoowei/yooweiTest.git", :tag => s.version }
- commit => "68defea" 表示将这个Pod版本与Git仓库中某个commit绑定
- tag => 1.0.0 表示将这个Pod版本与Git仓库中某个版本的comit绑定
- tag => s.version 表示将这个Pod版本与Git仓库中相同版本的comit绑定
// 引用libxml2.lib和libz.lib.
spec.libraries = 'xml2', 'z'
2、引用公有framework:"(.ios).framework" 用”,”分割. 去掉尾部的”.framework”
spec.frameworks = 'UIKit','SystemConfiguration', 'Accelerate'
3、引用自己生成的framework:’(.ios).vendored_frameworks’ 用”,”分割 路径写从.podspec所在目录为根目录的相对路径 ps:这个不要省略.framework spec.ios.vendored_frameworks = 'Pod/Assets/*.framework'
4、引用自己生成的.a文件, 添加到Pod/Assets文件夹里. Demo的Example文件夹里也需要添加一下, 不然找不到
spec.ios.vendored_libraries = 'Pod/Assets/*.a'
注意:在提交到私有仓库的时候需要加上--use-libraries
4.创建LICENSE(许可证/授权)文件,此文件必须要有
创建一个文件名字命名为LICENSE,内容为:只需要把前面的版权改一下就行了,后面的都一样。MIT LicenseCopyright (c) 2017Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
但是:一般我们创建仓库的时候,大多数已经创建好了的。
5.上传到Git
将包含配置好的 .podspec, LICENSE 的项目提交 Git仓库6.打tag
$ git tag7.验证.podspec文件
到此检查一下你工程下面的文件, 你的项目, .podspec文件, LICENSE文件是否存在。验证会先测试本地 .podspec 文件是否存在语法错误.// --verbose 如果验证失败会报错误信息
$ pod spec lint yooweiTest.podspec --verbose
yooweiTest.podspec passed validation.
前段时间操作遇到的错误和警告:
1、
-> yooweiTest (1.0)
- WARN | github_sources: Github repositories should end in `.git`. //注意需要以.git结尾
- WARN | description: The description is equal to the summary.
- NOTE | xcodebuild: warning: no rule to process file 'yooweiTest/JSPatchtest/yoowei/JSPatch.js' of type sourcecode.javascript for architecture i386
- NOTE | xcodebuild: warning: no rule to process file 'yooweiTest/JSPatchtest/yoowei/JSPatch.js' of type sourcecode.javascript for architecture x86_64
Analyzed 1 podspec.
[!] The spec did not pass validation, due to 2 warnings (but you can use `--allow-warnings` to ignore them).
[!] The validator for Swift projects uses Swift 3.0 by default, if you are using a different version of swift you can use a `.swift-version` file to set the version for your Pod. For example to use Swift 2.3, run:
`echo "2.3" > .swift-version`.
$ pod lib lint --allow-warnings
$ echo "2.3" > .swift-version
2、 -> JSPatchtest (1.0.0)
- ERROR | name: The name of the spec should match the name of the file.// 这个是要保证.podspe文件的名称和里面s.name保持一致
- WARN | github_sources: Github repositories should end in `.git`.
- WARN | description: The description is equal to the summary.
- ERROR | [iOS] unknown: Encountered an unknown error (No podspec found for `JSPatchtest` in `/Users/galahad/Desktop/yooweiTest`) during validation.
[!] JSPatchtest did not pass validation, due to 2 errors and 2 warnings.
3 、
[!] Error installing JSPatchtest
-> yooweitest (1.0.0)
- WARN | description: The description is shorter than the summary.
- ERROR | [iOS] unknown: Encountered an unknown error ([!] /usr/bin/git clone https://github.com/yoowei/yooweiTest.git /var/folders/rg/gmjp61bx0x95t4tjx2hh_3sr0000gn/T/d20170113-4028-cvivmq --template= --single-branch --depth 1 --branch 1.0.0
[!] The spec did not pass validation, due to 1 error and 1 warning.
sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
(-switch 后面加上你的Xcode.app包内容里的Developer的文件夹路径即可).
验证成功后:
yooweiTest passed validation.
验证失败:
[!] The spec did not pass validation, due to 1 error.
如果出现错误,就各式各样,根据描述进行解决就可以了。
8.注册Trunk
如果要添加到Cocoapods的官方库了,可以使用trunk工具,具体可以查看官方文档。如果是私有库的话,详见:http://www.cnblogs.com/richard-youth/p/6289015.htmlpod --version
命令查看版本,如果CocoaPods版本低,需要升级。已经注册过的不需要注册,怎么看自己有没有注册
$ pod trunk me
- Name: yoowei
// 加上--verbose可以输出详细debug信息,方便出错时查看。
$ pod trunk register yoowei@126.com "yoowei" --verbose
补充:
我们显示隐藏文件后,在用户目录下,找到 /Users/galahad/.rvm
直接将隐藏文件.rvm删除9.发布
发布时会验证 Pod 的有效性,如果你在上面步骤中手动验证 Pod 时使用了 --use-libraries 或 --allow-warnings 等修饰符,那么发布的时候也应该使用相同的字段修饰,否则出现相同的报错。pod trunk push yooweiTest.podspec
--allow-warnings
成功了以后会出现以下内容
![](https://i-blog.csdnimg.cn/blog_migrate/f322bccc92169dbb24d3283a0cb48a74.png)
这个时候,再用
$ pod search yoowei
[!] Unable to find a pod with name, author, summary, or description matching `yoowei`
pod setup
成功后会生成~/Library/Caches/CocoaPods/search_index.json
文件。
终端输入rm ~/Library/Caches/CocoaPods/search_index.json
删除成功后再执行pod search 一切OK?
$ rm ~/Library/Caches/CocoaPods/search_index.json
$ pod search yoowei
Creating search index for spec repo 'master'.. Done!
$ pod search yoowei
-> yooweiTest (1.0)
yooweiTest just test.
pod 'yooweiTest', '~> 1.0'
- Homepage: https://github.com/yoowei/yooweiTest
- Source: https://github.com/yoowei/yooweiTest.git
- Versions: 1.0 [master repo]
![](https://i-blog.csdnimg.cn/blog_migrate/4571b0a35c3ec69f26b68e72b0d776b0.png)
可以利用 pod trunk info yooweiTest 查询相关信息
![](https://i-blog.csdnimg.cn/blog_migrate/1606136a4f9ebef3ea974f05217d987c.png)