美文网首页iOS开发技术分享Swift_LearniOS Developer
发布CocoaPods组件碰到的坑与心得体会

发布CocoaPods组件碰到的坑与心得体会

作者: sxtra | 来源:发表于2016-12-07 11:36 被阅读3771次

    本文使用trunk方式发布代码到CocoaPods,在发布过程中碰到了不少坑,浪费了很多时间,也收获了经验和成功的喜悦。

    网上看的教程大部分只集中在某些方面如pod trunk命令使用,或podspec文件的详细介绍,并没有对从提交GitHub到发布CocoaPods整个流程作描述,以至于在发布过程中只将自己写的组件(Class文件)上传到GitHub,然后以Class文件发布到CocoaPods的时候提示各种各样的错误而无法解决。最后通过对比CocoaPods的已发布项目,观察其中的异同,终于成功发布。

    本文将以XLPhotoBrowser组件a component of photo browser on iOS)为演示组件,详细描述将XLPhotoBrowser组件发布到CocoaPods的过程,记录其中的坑和心得体会,也让每个开发者都能方便快捷地使用访XLPhotoBrowser组件。

    在发布自己的组件时,需用组件名称替换XLPhotoBrowser

    本文着重点在发布第三方库的步骤,并对各步骤的注重事项做标记,写点心得体会,同时也是记录发布的流程和注意点,免得忘记。

    发布代码到CocoaPods,主要的步骤如下:

    发布流程

    上图列出了主要步骤,分析如下:

    1、发布GitHub项目

    此时发布的项目应该是能正常运行的完整XCode工程,其中包含了要发布的组件。
    CocoaPods都托管在GitHub上(官方链接为:https://github.com/CocoaPods ),所有的Pods库也都依赖GitHub,因此第一步需要创建自己的GitHub仓库,将Pods库的demo工程上传到仓库。

    1.1、创建GitHub仓库

    经常提交代码的应该都知道如何在GitHub官网(官网地址:https://github.com )新建仓库,特别注意的是:选择一个许可证

    1.2、git clone 克隆远程库到本地,在文件夹下创建XCode demo工程,将自己的组件放到单独的文件夹;

    1.3、让demo跑起来,达到预期完整功能;

    1.4、提交demo工程到GitHub;

    $ git push origin master

    2、发布到CocoaPods

    已经提交代码到GitHub以后,就能着手发布到CocoaPods了。以下是CocoaPods的步骤:

    2.1、注册trunk,

      $ pod trunk register eloy@example.com 'Eloy Durán’    #注册,会发带验证链接的邮件到邮箱地址,名称无法修改
      $ pod trunk me    #可查询注册信息。
    

    注意:邮箱是GitHub上的邮箱,名称随意但是无法修改。命令执行完后邮箱会收到带有验证链接的邮件,打开链接就能完成trunk注册流程。

    2.2、生成podspec文件

      $ pod spec create XLPhotoBrowser
    

    会在当前目录下生成XLPhotoBrowser.podspec文件,里面有非常多的注释,大部分都是无用的。建议删除内容,直接使用其它成功提交的podspec文件修改

    2.3、打tag

      $ git tag 1.0.1    #给源代码打版本标签,与podspec文件中version一致即可
      $ git push --tag  
    

    2.4、 验证podspec文件是否合法

      $ pod lib lint    #需要验证一下,以便提前发现问题。
    

    2.5、更新GitHub仓库

     $ git add .                   #将当前目录下所有文件和子目录的修改记录到Git索引中
     $ git status                  #列出当前目录下被修改还未提交的状态
     $ git commit -m ‘first commit’     #提交被add的改动
     $ git push origin master           #push代码到Git
    

    2.6、发布到CocoaPods

     $  pod trunk push XLPhotoBrowser.podspec
     验证podspec是否合法,上传pod spec文件到CocoaPods,并将podspec文件转成json格式
    

    当终端出现类似以下输出时,代表已经提交成功,等待审核即可。我的第1次提交审核了十几分钟。

    - Log messages:
        - December 5th, 20:46: Push for `XLPhotoBrowser 1.0.0' initiated.
        - December 5th, 20:46: Push for `XLPhotoBrowser 1.0.0' has been pushed
    

    3、搜索CocoaPods第三方库

    两种方法:
    方法一:使用$ pod setup命令更新本地pod依赖树,再使用$ pod search XLPhotoBrowser命令搜索;
    方法二:官网查询(官网地址: https://cocoapods.org/?q=XLPhotoBrowser

    4.使用该第三方库(CocoaPods使用操作)

    </br>

    5.坑与解决方案:

    在整个过程中碰到不少坑,整理如下:

    5.1.新建的GitHub仓库没有选择许可证。没法,只能删了重新建。
    5.2.没有建demo工程并上传到GitHub。只传了Class文件,这个时候验证podspec是通不过的。

    会报如下错误:

    -> XLPhotoBrowser (1.0.0)
    - ERROR | [iOS] xcodebuild: Returned an unsuccessful exit code. You can use `--verbose` for more information.
    
    5.3.swift版本不对
    [!] The validator for Swift projects uses Swift 2.3 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 3.0, run:
        `echo "3.0" > .swift-version`.
    

    使用echo "3.0" > .swift-version命令即可。

    5.4.podspec文件配置不对。

    之前用pod spec create XLPhotoBrowser命令生成的,大概看了下要配置的地方(看名字就知道配置的是什么)。发现太杂,太多配置用不上,就全删了用其它成功上传的podspec内容替换,再配置相关内容。

    需要注意的是s.source_files参数,如果配置为s.source_files = '/*.{h,m}’,会报错:

    - ERROR | File Patterns: File patterns must be relative and cannot start with a slash (source_files).
    

    其它可能的报错:

    -> XLPhotoBrowser (1.0.0)
        - ERROR | [iOS] file patterns: The `source_files` pattern did not match any file.
    

    此处,直接使用 s.source_files = 'XLPhotoBrowser/**/*.{h,m}’即可

    5.5.如果依赖了其它CocoaPods第三方库

    请使用s.dependency配置,如 s.dependency "SDWebImage", "~> 3.7.1"

    配参过程中可参考以下附录内容,或查看链接:
    https://github.com/xiaoL0204/XLPhotoBrowser/blob/master/XLPhotoBrowser.podspec

    5.6.忘记打tag

    报错如下,使用git tag 1.0.0命令即可

    Validating podspec
     -> XLPhotoBrowser (1.0.0)
        - ERROR | [iOS] unknown: Encountered an unknown error ([!] /Applications/Xcode.app/Contents/Developer/usr/bin/git clone https://github.com/xiaoL0204/XLPhotoBrowser.git /var/folders/w1/95fypdq96l92t55frcn0yhyh0000gn/T/d20161206-1790-put1kd --template= --single-branch --depth 1 --branch 1.0.0
    
    Cloning into '/var/folders/w1/95fypdq96l92t55frcn0yhyh0000gn/T/d20161206-1790-put1kd'...
    warning: Could not find remote branch 1.0.0 to clone.
    fatal: Remote branch 1.0.0 not found in upstream origin
    ) during validation.
    
    [!] The spec did not pass validation, due to 1 error.
    

    附录

    1.XLPhotoBrowser.podspec文件内容为:
    Pod::Spec.new do |s|
        s.name         = 'XLPhotoBrowser'
        s.version      = '1.0.1'
        s.summary      = 'a component of photo browser on iOS'
        s.homepage     = 'https://github.com/xiaoL0204/XLPhotoBrowser'
        s.description  = <<-DESC
                                          It is a component for ios photo browser,written by Objective-C.
                       DESC
        s.license      = 'MIT'
        s.authors      = {'xiaoL0204' => 'xiaol0204@qq.com'}
        s.platform     = :ios, '6.0'
        s.source       = {:git => 'https://github.com/xiaoL0204/XLPhotoBrowser.git', :tag => s.version}
        s.source_files = 'XLPhotoBrowser/**/*.{h,m}'
        s.dependency "SDWebImage", "~> 3.7.1"
        s.requires_arc = true
    end
    

    </br>

    2.项目、Demo地址

    GitHub地址:https://github.com/xiaoL0204/XLPhotoBrowser

    3.CocoaPods中如何使用该组件:
    platform :ios,'7.0'
    
    target ‘PhotoBrowserDemo' do
    pod 'XLPhotoBrowser', '~>1.0.1'
    end
    

    相关文章

      网友评论

      • 苜蓿鬼仙:-> XLPhotoBrowser (1.0.0)
        - ERROR | [iOS] file patterns: The `source_files` pattern did not match any file.

        这个报错,s.source_files = 'XLPhotoBrowser/**/*.{h,m}’ 这种方式解决不了呀?请问一下为什么呀?
        heron_funny:你把原来的git仓库删掉, 重新建一个git仓库, 然后在仓库里新建项目, 将原来的文件拖进去, 然后, 新建spec文件, 后面都是正常程序走, 应该能成功, 我也碰到过你的问题, 就是这样解决的
      • 苜蓿鬼仙:请问在注册环节,每新上传一个库,注册的邮箱和用户名就要变更一次吗
      • itmarsung:楼主:我在 pod trunk register xxx@163.com "name"时就出错了。

        ### Error

        ```
        Netrc::Error - Permission bits for '/Users/marsung/.netrc' should be 0600, but are 644
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/netrc-0.7.8/lib/netrc.rb:33:in `check_permissions'
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/netrc-0.7.8/lib/netrc.rb:40:in `read'
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/cocoapods-trunk-1.2.0/lib/pod/command/trunk.rb:106:in `netrc'
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/cocoapods-trunk-1.2.0/lib/pod/command/trunk/register.rb:72:in `save_token'
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/cocoapods-trunk-1.2.0/lib/pod/command/trunk/register.rb:62:in `run'
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/claide-1.0.1/lib/claide/command.rb:334:in `run'
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/cocoapods-1.2.1/lib/cocoapods/command.rb:52:in `run'
        /Users/marsung/.rvm/gems/ruby-2.3.0@global/gems/cocoapods-1.2.1/bin/pod:55:in `<top (required)>'
        /Users/marsung/.rvm/rubies/ruby-2.3.0/bin/pod:22:in `load'
        /Users/marsung/.rvm/rubies/ruby-2.3.0/bin/pod:22:in `<main>'
        /Users/marsung/.rvm/gems/ruby-2.3.0/bin/ruby_executable_hooks:15:in `eval'
        /Users/marsung/.rvm/gems/ruby-2.3.0/bin/ruby_executable_hooks:15:in `<main>'
        ```


        [!] Oh no, an error occurred.

        Search for existing GitHub issues similar to yours:
        https://github.com/CocoaPods/CocoaPods/search?q=Permission+bits+for+%27%2FUsers%2Fmarsung%2F.netrc%27+should+be+0600%2C+but+are+644&type=Issues

        If none exists, create a ticket, with the template displayed above, on:
        https://github.com/CocoaPods/CocoaPods/issues/new

        Be sure to first read the contributing guide for details on how to properly submit a ticket:
        https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md

        请问这种问题出在哪?我开始以为cocoapods版本的问题,后来索性把cocoapods和gem都更新到最新了,发现还是不行。
      • pythonboy:你好,我的为什么通过pod search 搜索不到,但是通过pod install 是可以安装的,pod spec lint 没问题。谢谢
        pythonboy:你这个XLPhotoBrowser,通过Pod search 也是搜索不到啊
      • 7afe30d6ef13:我也遇到本地验证报 - ERROR | [iOS] xcodebuild: Returned an unsuccessful exit code. You can use `--verbose` for more information. 但是没有理解你说的 没有建demo工程 的意思 求解答
        sxtra:@963554461 可以检查一下工程是否是MRC的。因为如果工程中使用了ARC,那么使用weak来修饰代理对象是正确的。
        7afe30d6ef13:@sxtra 谢谢你,请问你有没有遇到CocoaPods组件建好后,导入工程中之后,比如组件中使用代理用weak修饰,然后运行工程,提示报错。把weak换成assign运行就正常。
        sxtra:需要创建一个可运行的demo,因为cocoapods会验证工程是否能运行、是否符合规范。如果demo可以跑,首先要确定cocoapods的版本不能是1.0.1

      本文标题:发布CocoaPods组件碰到的坑与心得体会

      本文链接:https://www.haomeiwen.com/subject/aqydmttx.html