[Cocoapods]使用Cocoapods + Github托管代码

记录使用cocoapods托管代码的一些步骤

一. 新建项目

Github上新建项目, 新建的时候要勾选许可类型:

如果是已有的项目, 可以从其他地方copy一个LICENSE文件, 放到项目的根目录下(与READEME.md同级)

然后, 使用Sourcetree, 将项目克隆到本地:

PS: 这里我使用的是Sourcetree, 也可以使用其他的方式克隆

新建一个项目, 随便添加一个文件( 你需要支持cocoapods的文件, 这里以LZTool类为例 ):

推送到Github:

关于Cocoapods的使用, 可参考这篇文章:[Cocoapods]第三方管理工具Cocoapods使用

二. 创建podspec文件

打开终端, 进入到项目的根目录:

 cd /Users/mac/Desktop/PodTest

然后执行下面的指令新建Podspec文件:

pod spec create LZTool

或者使用touch指令也可以, 文件名称要写全:

// 文件名称需要添加后缀
touch LZTool.podspec

这里的LZTool, 就是你在使用cocoapods时写到Podfile文件内的名称;

pod spec create 文件名称

执行结果:

此时, 本地文件夹下就多了一个文件: LZTool.podspec
在终端, 打开这个文件(或者使用其他的方式打开, 例如: 文本编辑器, Xcode, VSCode等 ):

vi LZTool.podspec

打开后, 会发现里面有很多内容, 如下 :

#
#  Be sure to run `pod spec lint LZTool.podspec' to ensure this is a
#  valid spec and to remove all comments including this before submitting the spec.
#
#  To learn more about Podspec attributes see http://docs.cocoapods.org/specification.html
#  To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
#

Pod::Spec.new do |s|

  # ―――  Spec Metadata  ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  These will help people to find your library, and whilst it
  #  can feel like a chore to fill in it's definitely to your advantage. The
  #  summary should be tweet-length, and the description more in depth.
  #

  s.name         = "LZTool"
  s.version      = "0.0.1"
  s.summary      = "A short description of LZTool."

  # This description is used to generate tags and improve search results.
  #   * Think: What does it do? Why did you write it? What is the focus?
  #   * Try to keep it short, snappy and to the point.
  #   * Write the description between the DESC delimiters below.
  #   * Finally, don't worry about the indent, CocoaPods strips it!
  s.description  = <<-DESC
                   DESC

  s.homepage     = "http://EXAMPLE/LZTool"
  # s.screenshots  = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"


  # ―――  Spec License  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Licensing your code is important. See http://choosealicense.com for more info.
  #  CocoaPods will detect a license file if there is a named LICENSE*
  #  Popular ones are 'MIT', 'BSD' and 'Apache License, Version 2.0'.
  #

  s.license      = "MIT (example)"
  # s.license      = { :type => "MIT", :file => "FILE_LICENSE" }


  # ――― Author Metadata  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the authors of the library, with email addresses. Email addresses
  #  of the authors are extracted from the SCM log. E.g. $ git log. CocoaPods also
  #  accepts just a name if you'd rather not provide an email address.
  #
  #  Specify a social_media_url where others can refer to, for example a twitter
  #  profile URL.
  #

  s.author             = { "LQQZYY" => "592852848@qq.com" }
  # Or just: s.author    = "LQQZYY"
  # s.authors            = { "LQQZYY" => "592852848@qq.com" }
  # s.social_media_url   = "http://twitter.com/LQQZYY"

  # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If this Pod runs only on iOS or OS X, then specify the platform and
  #  the deployment target. You can optionally include the target after the platform.
  #

  # s.platform     = :ios
  # s.platform     = :ios, "5.0"

  #  When using multiple platforms
  # s.ios.deployment_target = "5.0"
  # s.osx.deployment_target = "10.7"
  # s.watchos.deployment_target = "2.0"
  # s.tvos.deployment_target = "9.0"


  # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the location from where the source should be retrieved.
  #  Supports git, hg, bzr, svn and HTTP.
  #

  s.source       = { :git => "http://EXAMPLE/LZTool.git", :tag => "#{s.version}" }


  # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  CocoaPods is smart about how it includes source code. For source files
  #  giving a folder will include any swift, h, m, mm, c & cpp files.
  #  For header files it will include any header in the folder.
  #  Not including the public_header_files will make all headers public.
  #

  s.source_files  = "Classes", "Classes/**/*.{h,m}"
  s.exclude_files = "Classes/Exclude"

  # s.public_header_files = "Classes/**/*.h"


  # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  A list of resources included with the Pod. These are copied into the
  #  target bundle with a build phase script. Anything else will be cleaned.
  #  You can preserve files from being cleaned, please don't preserve
  #  non-essential files like tests, examples and documentation.
  #

  # s.resource  = "icon.png"
  # s.resources = "Resources/*.png"

  # s.preserve_paths = "FilesToSave", "MoreFilesToSave"


  # ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Link your library with frameworks, or libraries. Libraries do not include
  #  the lib prefix of their name.
  #

  # s.framework  = "SomeFramework"
  # s.frameworks = "SomeFramework", "AnotherFramework"

  # s.library   = "iconv"
  # s.libraries = "iconv", "xml2"


  # ――― Project Settings ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If your library depends on compiler flags you can set them in the xcconfig hash
  #  where they will only apply to your library. If you depend on other Podspecs
  #  you can include multiple dependencies to ensure it works.

  # s.requires_arc = true

  # s.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
  # s.dependency "JSONKit", "~> 1.4"

end

文件里划分了好几个区:


1. Spec Metadata : 元数据规范

这些内容是你的类库信息

  • s.name : 类库的名称
  • s.version : 类库的版本号
  • s.summary : 类库的摘要(简介)
  • s.description : 描述, 用于生成标签和提高搜索结果, 主要是类库的功能等, 尽量简短; 注意, 需要写在两个DESC中间
  • s.homepage : 类库的地址链接
    s.summary- s.screenshots : 效果图链接

2. Spec License : 开源许可证

3. Author Metadata : 作者信息
  • s.author :作者
  • s.social_media_url : 个人主页地址

4. Platform Specifics : 平台信息
  • s.platform : 平台 例如: iOS , tvOS, watchOS等,
    在平台信息后可以跟上需要的最低版本, 例如:
  • s.platform = :ios, "8.0"
    如果可以支持多个平台, 可使用下面的方式指定:
  • s.ios.deployment_target = "5.0"
  • s.osx.deployment_target = "10.7"
  • s.watchos.deployment_target = "2.0"
  • s.tvos.deployment_target = "9.0"

5. Source Location : 文件地址

从哪里可以获得这些文件, 支持 git, hg, bzr, svn and HTTP.

  • s.source : 链接地址

6. Resources : 资源
  • s.resource = "icon.png":单个资源
  • s.resources = "Resources/*.png" : 某个文件夹下的多个资源
  • s.preserve_paths = "FilesToSave", "MoreFilesToSave" : 需要保存的文件

7. Source Code : 共享源文件
  • s.source_files : 文件的相对路径
  • s.public_header_files : 公开的头文件, 如果不设置这个, 默认公开所有的头文件
  • s.exclude_files = "Classes/Exclude" 排除不需要的文件

8. Project Linking : 链接库和框架
  • s.framework = "SomeFramework" 单个framework
  • s.frameworks = "SomeFramework", "AnotherFramework" 多个库framework
  • s.library = "iconv" 指定导入的库,比如sqlite3
  • s.libraries = "iconv", "xml2" 多个库

9. Project Settings : 工程设置
  • s.requires_arc = true 需要ARC
  • s.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" } 项目配置
  • s.dependency "JSONKit", "~> 1.4" 需要其他第三方库的支持,如果有多个第三方库,就写多个 s.dependency

完成后, 执行下面的指令来验证这个文件是否可用:

pod lib lint LZTool.podspec

如果有错误, 根据错误提示, 进行修改; 如果仅仅是警告, 不想修改的话, 可以使用下面的指令来忽略:

pod lib lint LZTool.podspec —allow-warnings

最后, 输出下面这个, 即是验证通过:

这里如果遇到错误, 可以参考[Cocoapods]项目添加Cocoapods支持遇到的坑中的解决思路.

三. 新建版本

来到Github 上, 创建release版本
选择release :

如果是个新的项目的话, 这里是没有任何版本信息的, 点击create a new release :

注意: 这里的Tag verson 一定要和上面设置的s.version以及s.source 中的 tag保持一致.

填好之后, 点击下面的Public release 即可完成!

四. 注册cocoapods账户

接下来输入以下指令, 来链接到你的cocoapods账户:
如果是首次使用:

// 邮箱  用户名   描述信息
pod trunk register 302934443@qq.com 'LQQ' --description='Test1'

如果已经注册, 可使用下面的指令:

pod trunk register eloy@example.com --description='Work Laptop'
pod trunk register eloy@example.com

不出错的话会输出:

根据提示, 到你的邮箱里去确认邮件即可!

注意: 这里的邮箱开始我使用的是163的邮箱, 好久都没有收到确认邮件, 然后改为qq邮箱, 立马就受到确认邮件了, 所以, 建议使用qq邮箱来注册.

确认结果如下所示:


这里如果遇到错误, 可以参考[Cocoapods]项目添加Cocoapods支持遇到的坑中的解决思路.

确认之后, 可以使用下面的指令来确认账号是否可用:

pod trunk me

如果可用, 会输出相关的信息:


五. 上传代码到Cocoapods

以上全部完成后, 最后一步就是上传代码到Cocoapods了;
首先, 使用下面的指令来检查文件是否可用:

pod spec lint

如果没有错误, 会输出:

PS: 如果有警告, 而我们又不想处理, 可用—allow-warnings忽略, 即:

pod spec lint —allow-warnings

这里如果遇到错误, 可以参考[Cocoapods]项目添加Cocoapods支持遇到的坑中的解决思路.

最后就是上传代码了, 使用下面的指令进行上传:

pod trunk push LZTool.podspec

上传的时间可能会有点长, 耐心等待, 成功后会输出:

上传成功

PS: 如果这里因为有警告而导致失败, 可以在后面添加--allow-warnings来忽略警告, 即:

pod trunk push LZTool.podspec --allow-warnings

然后, 可用使用下面的指令来查看是否可用:

pod search LZTool

注意: 这里有一个坑, 上面显示成功, 但是我在使用指令搜索的时候, 怎么都搜不到, 然后新建了一个工程, 添加pod 'LZTool'至Podfile**, 文件, 然后就能正常下载文件:

六. 更新

如果我们需要更新自己的类库, 只需要将最新的代码提交到Github, 然后创建新的release版本, 注意: 这里的版本要和podspec文件内的s.version一致, 然后再执行一遍下面的指令即可:

pod trunk push LZTool.podspec --allow-warnings

最后附上本次实例的podspec文件内容:

Pod::Spec.new do |s|

  s.name         = "LZTool"
  s.version      = "0.0.1"
  s.summary      = " This is some summary for LZTool"

  s.description  = <<-DESC 
                          LZTool 是一个用于保存一些常用工具类的工具
                   DESC

  s.homepage     = "https://github.com/LQQZYY/LZTool"

  s.license      = "MIT"

  s.author    = "LQQZYY"
  s.platform     = :ios, "8.0"

  s.source       = { :git => "https://github.com/LQQZYY/PodTest.git", :tag => "0.0.1" }
  s.source_files = "LZTool"

  s.requires_arc = true

end

最后, 对于.podspec文件的编写, 可以下载其他的第三方库来学习里面的.podspec的编写技巧.

参考文章

从零开始,让你的框架支持CocoaPods

把自己Github上的代码添加Cocoapods支持

(完)

推荐阅读更多精彩内容