建立本身的github仓库

做者: wangzz 
原文地址:http://blog.csdn.net/wzzvictory/article/details/20067595 

1、建立本身的github仓库

CocoaPods都托管在github上(官方连接为:https://github.com/CocoaPods),全部的Pods依赖库也都依赖github,所以第一步咱们须要建立一个属于本身的github仓库。仓库建立界面以下图: \
上图中标了序号的共6处,对应的说明以下: 一、Repository name 仓库名称,这里写成WZMarqueeView,必填的; 二、Description 仓库的描述信息,可选的; 三、仓库的公开性 这里只能选Public,一个是由于Private是要money的,再一个Private别人看不到还共享个毛; 四、是否建立一个默认的README文件 一个完整地仓库,都须要README说明文档,建议选上。固然不嫌麻烦的话你也能够后面再手动建立一个; 五、是否添加.gitignore文件 .gitignore文件里面记录了若干中文件类型,凡是该文件包含的文件类型,git都不会将其归入到版本管理中。是否选择看我的须要; 六、license类型 正规的仓库都应该有一个license文件,Pods依赖库对这个文件的要求更严,是必需要有的。所以最好在这里让github建立一个,也能够本身后续再建立。我使用的license类型是MIT。
上面的各项都填写完毕后,点击Create repository按钮便可,建立成功地界面如图: \
到这,仓库建立过程就结束了。

2、clone仓库到本地

为了便于向仓库中删减内容,须要先将仓库clone到本地,操做方式有多种,推荐使用命令行:
1. $ git clone https://github.com/wangzz/WZMarqueeView.git
操做完成后,github上对应的文件都会拷贝到本地,目录结构为: \
github上仓库中的.gitignore文件是以.开头的隐藏文件,所以这里只能看到两个。 后续咱们的全部文件增、删、改都在这个目录下进行。

3、向本地git仓库中添加建立Pods依赖库所需文件

注意:如下描述的文件都要放在步骤二clone到本地的git仓库的根目录下面。

一、后缀为.podspec文件

该文件为Pods依赖库的描述文件,每一个Pods依赖库必须有且仅有那么一个描述文件。文件名称要和咱们想建立的依赖库名称保持一致,个人WZMarqueeView依赖库对应的文件名为WZMarqueeView.podspec。

1.1 podspec文件内容html

WZMarqueeView.podspec的保存内容为:
01. Pod::Spec.new do |s|
02. s.name             = "WZMarqueeView"
03. s.version          = "1.0.0"
04. s.summary          = "A marquee view used on iOS."
05. s.description      = <<-DESC
06. It is a marquee view used on iOS, which implement by Objective-C.
07. DESC
08. s.homepage         = "https://github.com/wangzz/WZMarqueeView"
09. # s.screenshots      = "www.example.com/screenshots_1""www.example.com/screenshots_2"
10. s.license          = 'MIT'
11. s.author           = { "王中周" => "wzzvictory_tjsd@163.com" }
12. s.source           = { :git => "https://github.com/wangzz/WZMarqueeView.git", :tag => s.version.to_s }
13. # s.social_media_url = 'https://twitter.com/NAME'
14.  
15. s.platform     = :ios, '4.3'
16. # s.ios.deployment_target = '5.0'
17. # s.osx.deployment_target = '10.7'
18. s.requires_arc = true
19.  
20. s.source_files = 'WZMarqueeView*.h'
26. s.frameworks = 'Foundation''CoreGraphics''UIKit'
27.  
28. end
该文件是ruby文件,里面的条目都很容易知道含义。 其中须要说明的又几个参数: ①s.license Pods依赖库使用的license类型,你们填上本身对应的选择便可。 ②s.source_files 表示源文件的路径,注意这个路径是相对podspec文件而言的。 ③s.frameworks 须要用到的frameworks,不须要加.frameworks后缀。

1.2 如何建立podspec文件ios

你们建立本身的podspec文件能够有两个途径: ①copy个人podspec文件而后修改对应的参数,推荐使用这种方式。 ②执行如下建立命令:
1. $ pod spec create WZMarqueeView
也会建立名为WZMarqueeView.podspec的文件。可是打开建立完的文件你就会发现里面的东西太多了,不少都是咱们不须要的。

二、LICENSE文件

CocoaPods强制要求全部的Pods依赖库都必须有license文件,不然验证不会经过。license的类型有不少种,详情能够参考网站tl;dr Legal。在建立github仓库的时候,我已经选择了MIT类型的license。

三、主类文件

建立Pods依赖库就是为了方便别人使用咱们的成果,好比我想共享给你们的WZMarqueeView类,是我想提供给广大用户使用的,这个类天然是必不可少的。我把这个类包含的两个文件放到一个名称为WZMarqueeView的文件夹中,对应的目录结构如图: \
里面包含两个文件:WZMarqueeView.h和WZMarqueeView.m

四、demo工程

为了快速地教会别人使用咱们的Pods依赖库,一般须要提供一个demo工程。我建立的demo工程放到了一个名为WZMarqueeViewDemo的文件夹中,该目录包含的文件以下图所示: \

五、README.md

使用github的人应该都熟悉这个文件,它是一个成功github仓库必不可少的一部分,使用的是markdown标记语言,用于对仓库的详细说明。
以上所说的5个是建立Pods依赖库所需最基础的文件,其中一、二、3是必需的,四、5是可选但强烈推荐建立的。 添加完这些文件之后,个人github本地仓库目录就变成了下图所示的样子: \

4、提交修改文件到github

通过步骤三,向本地的git仓库中添加了很多文件,如今须要将它们提交到github仓库中去。提交过程分如下几步:

一、pod验证

执行如下命令:
1. $ set the new version to 1.0.0
2. $ set the new tag to 1.0.0
这两条命令是为pod添加版本号并打上tag。而后执行pod验证命令:
1. $ pod lib lint
若是一切正常,这条命令执行完后会出现下面的输出:
1. -> WZMarqueeView (1.0.0)
2.  
3. WZMarqueeView passed validation.
到此,pod验证就结束了。 须要说明的是,在执行pod验证命令的时候,打印出了任何warning或者error信息,验证都会失败!若是验证出现异常,打印的信息会很详细,你们能够根据对应提示作出修改。

二、本地git仓库修改内容上传到github仓库

依次执行如下命令:
1. $ git add -A && git commit -m "Release 1.0.0."
2. $ git tag '1.0.0'
3. $ git push --tags
4. $ git push origin master
上述命令均属git的范畴,这里很少述。若是一切正常,github上就应该能看到本身刚添加的内容了。以下图所示: \


5、上传podspec文件到CocoaPods官方仓库中

通过前边的四步操做,你可能觉得已经结束了,不幸的是还早着呢。 要想一个Pods依赖库真正可用,还须要作最后一步操做,将咱们刚才生成的podspec文件上传到CocoaPods官方的Specs仓库中,连接为:https://github.com/CocoaPods/Specs 打开这个连接你就会发现,原来咱们能使用的,以及咱们使用pod search命令能搜索到的全部Pods依赖库都会把它们的podspec文件上传到这个仓库中,也就是说,只有将咱们的podspec文件上传到这个仓库中之后,才能成为一个真正的Pods依赖库,别人才能正常使用! 按照git的规则,要想向别人的仓库中添加文件,必须先fork一份别人的仓库,作完相应地修改后,在push给仓库的原做者,等到做者审核经过,而后合并到原来的仓库中。 流程明白了之后,天然知道该怎么干了:

一、fork一份CocoaPods官方的Specs仓库

进入到刚才的官方仓库连接中,点击屏幕右上角的fork按钮,以下图: \

而后你们会发现本身名下会多一份仓库的分支。好比个人分支为: \

二、将fork的仓库clone到本地

执行如下命令:
1. $ git clone https://github.com/wangzz/Specs.git
注意,你们须要将对应的仓库地址换成本身的。 这个仓库有点大,须要有耐心啊。

三、将本身的podspec文件添加到本地Specs仓库中

Specs 仓库clone到本地后,会放到一个名为Specs的文件夹中。podspec文件在Specs仓库中的保存原则是: Pods依赖库同名文件夹--->版本号同名文件夹--->podspec文件 照此原则,我须要在Specs文件夹下创建一个名为WZMarqueeView的文件夹,而后进入到WZMarqueeView文件夹下,创建一个名称为 1.0.0的文件夹,最后进入到1.0.0这个文件夹下,而且将以前建立好的WZMarqueeView.podspec文件拷贝进来。 不难理解,若是之后有对WZMarqueeView类的升级,就在WZMarqueeView文件夹下创建对应版本名称的文件夹,用于保存对应版本的 podspec文件便可。 这些操做完成后,目录层次结构以下所示: \

四、上传本地Specs仓库中的修改到github仓库

执行如下命令:
1. $ git add -A && git commit -m "Add WZMarqueeView podspec file"
2. $ git push origin master
成功之后就能在github上本身fork的Specs仓库中看到刚上传的文件了。

五、将在本身fork的Specs上作的修改pull给CocoaPods官方的Specs仓库

进入到本身fork的Specs仓库中,会看到屏幕左上角有一个绿色按钮: \
该按钮点进去之后会有以下图所示的界面: \
点击图中的绿色Create Pull Request按钮,便可将咱们fork的Specs上作的修改pull给CocoaPods官方的Specs仓库。
到这一步后,剩下的工做就只有等了,等待CocoaPods的维护人员审核并将咱们pull上去的修改合并到官方的Specs仓库中,这个过程一般会有一天左右的等待时间。若是有任何消息,好比审核不经过,或者审核经过了,CocoaPods官方都会发邮件通知的。 等到审核经过的时候,咱们就能在官方的Specs仓库中看到本身上传的文件夹了。

六、查看审核进度

固然咱们也能查看审核进度,打开这个连接:https://github.com/CocoaPods/Specs/pulls,这里能看到全部的Specs仓库pull请求,以下图: \
红圈标识的就是我刚才pull上来的请求,点进去之后就能看到对应的审核进度。

6、查看咱们本身建立的Pods依赖库

若是收到了CocoaPods官方发过来的审核经过邮件之后,你可能很着急的想在本身的电脑上执行pod search命令,看看能不能搜索到本身建立的Pods依赖库。不过你确定会失望的,由于还须要执行一条命令才能在咱们的本地电脑上使用search命令搜索到咱们的依赖库:
1. $ pod setup
在个人CocoaPods系列教程中的第一篇:CocoaPods详解之----进阶篇中的最后部分介绍过这条命令,它会将全部的Pods依赖库tree跟新到本地。执行完这条命令,再去执行:
1. $ pod search WZMarqueeView
就能显示出对应的介绍信息了!
相关文章
相关标签/搜索