从零开始到提交一个开源项目到Cocopods

iOS组件化要用到Cocopods,让我们讨论一下那么怎么创建自己的Cocoapods并且在多个项目组成员中间使用。

开发过程

  1. 执行pod lib create [ProjectName]创建项目。过程中需要回答几个问题,根据自己的需要设置设置就可以了。我的设置是:

    • What platform do you want to use?? [ iOS / macOS ]

      iOS

    • What language do you want to use?? [ Swift / ObjC ]

      Swift

    • Would you like to include a demo application with your library? [ Yes / No ]

      Yes

    • Which testing frameworks will you use? [ Quick / None ]

      None

    • Would you like to do view based testing? [ Yes / No ]

      No

      紧接着会自动执行pod install,我们只需要静静的等着完成就可以了。

  2. 项目结构。 pod install之后,Cocoapods会直接打开Xcode project。项目结构如下:
    project-struct

    1. Podspec Metadata
      • .podpsec - 项目相关的pod信息。包括了版本号、github主页、对其他项目的依赖、作者信息和指定资源文件
      • README.md - 对当前项目的介绍和使用方法。也就是github中项目主页的介绍内容。
      • LICENSE - 指定使用的开源协议
    2. Example for DemoProj - 对开源代码的使用实例。其他人从github下载了开源项目后可以通过这个来查看使用方法。如果在Would you like to include a demo application with your library?中选择了No,这个项目就不会创建。因此强烈建议这个问题回答YES。对自己调试和别人使用都非常有利。
    3. Tests - 单元测试。
    4. Development Pods - 开源库代码就放在这里。
    5. Frameworks - 当前开源项目的依赖库
  3. .podspec文件详解

    • s.name - 名称,pod search搜索的关键词,注意这里一定要和.podspec的名称一样,否则报错
    • s.version - 版本号,这个版本号要和tag版本一致,否则报错
    • s.summary - 项目简介,pod search的结果中会展示
    • s.homepage - 项目主页地址,也就是github地址
    • s.source - git clone的项目地址。
    • s.ios.deployment_target - 支持到的iOS版本
    • s.source_files - 资源文件路径。请确保把项目相关的源文件放在这个文件夹下面,否则报错。
    • s.dependency - 项目依赖的其他三方库。
  4. 在github上创建仓库

  5. 开发项目。。。

  6. 开发结束,把项目提交到github。

  7. 打tag并把tag提交。tag号要和.podspec中的s.server一致。

  8. 验证.podspec

    1. pod lib lint本地验证
    2. pod spec lint和github上的内容进行对比
  9. 把项目发布到Cocopods的master上。pod trunk push [ProjectName].podspec。注意,这个过程较(chao ji)慢。

可能遇到的问题

  1. pod lib lint通过,但是pod spec lint报错:use of unresolved identifier。遇到这个问题后,分为两步:
    1. pod spec lint --no-clean --verbose查看错误原因,这是会看到临时文件,到临时文件里查看会发现缺少文件
    2. 使用pod cache clean
    3. 重新执行一次pod spec lint
  2. 项目提交后执行pod search找不到的话,执行pod setup
  3. 验证的时候出现.swift-version错误。解决办法是在项目目录下创建一个执行echo "4.0" > .swift-version。注意,这里的4.0是我开发项目时使用的Swift版本。
  4. 注意权限控制和Swift与OC的混编问题

赠送一个提交开源库的shell脚本

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# bin/sh
# 验证本地 pod lib lint
echo 'pod lib lint...\n'
pod lib lint

# 下拉git git pull
echo '\ngit pull...\n'
git pull
echo `git pull`

# 上传git git add git commit git push
echo "git add . \n"
git add .
echo "Enter a commit message: \c"
read commitMsg
echo "git commit -m $commitMsg"
git commit -m '$commitMsg'

# tag git tag git push --tags
echo "\ngit push ...\n"
git push

echo "\nEnter tag version: \c"
read tagVersion
git tag $tagVersion
echo "\n git push --tags ..."
git push --tags

# 远程验证 pod spec lint
echo "\npod spec lint ...\n"
pod spec lint

# 提交代码 pod trunk
echo "\npod trunk push ...\n"
pod trunk push [yourprojectname].podspec

👍👍👍