将自己的SDK上传到github并用cocoapods管理
后台搞重构,特么接口变了不少,之前的不少接口有变化,改的烦死了。改完觉得这样不行啊尼玛,原先afn只封装了一层,然后参考了下github上的开源库,对封装进行了修改,后面打算抽时间再在自己项目里再封装一层。想着改都改了干脆做成自己的SDK,以后有新项目也可以用,方便移植。
昨天搞了大半天上传SDK的事情,记录一下。先文字,图后面再上传SDK的时候再截。
-
首先肯定是要在GitHub上注册一个账号并登陆,首页右上角点击“+”创建一个 New repository,跳转到创建设置界面,name一般与sdk项目相同,description就是简介,因为是作为sdk,所以选择Public,点选README,也可以在这里直接选add.gitgnore和add license,不过我看的教程是用终端创建的,下文会提到,下次试试。
点绿色的Create repository完成工程创建. -
创建工程。跳转到了自己的工程页面后,点击Clone,将带隐藏的.git文件的同名工程文件夹下载到本地,假设该目录为a。假设我们已经写好了SDK并放在了一个文件夹里名叫SDK,那我们在刚才下载的目录下创建工程,名叫SDK-demo,用于演示SDK使用;在工程同级放一个SDK文件夹,用于提供给cocoapods。这样能使我们的工程结构清晰明了。
-
将工程上传到GitHub。可以用终端也可以用GitHubDesktop对工程进行管理。个人习惯用终端.
cd到a。
git add -A
git commit -m 'sdk'
git push origin master -
注册一个cocoapods账号。直接在终端输入 pod trunk me 查看自己的账号信息,未注册则输入pod trunk register 按照提示输入账号密码注册,注意这里要在对应邮箱中打开接受到的链接,打开后能看到注册成功提示。
-
创建. podspec文件。该文件为Pods依赖库的描述文件,每个Pods依赖库必须有且仅有那么一个描述文件。文件名称要和我们想创建的依赖库名称保持一致。
再cd到a
pod spec create SDK
vi SDK.podspec
i
各种编辑
:wq
会发现创建的podspec里面一大堆不需要的文字,删也要删个半天,所以推荐的方法是,
找个成熟的SDK复制他的podspec文件到a,改名为SDK
vi SDK.podspec。
i
各种编辑
:wq
这里对文件里的内容要进行总结一下,因为填不好就无法提交到cocoapods
以我的SDK的文件内容做🌰
Pod::Spec.new do |s|
s.name = "TYNetworkTool" #SDK名称
s.version = "0.0.2" #版本号
s.homepage = "https://github.com/TianyongWang/TYNetworkTool" #工程主页地址
s.summary = "A short description of TYNetworkTool." #项目的简单描述
s.license = "MIT" #协议类型
s.author = { "MasazumiQi" => "47940062@qq.com" } #作者及联系方式
s.platform = :ios #支持的平台
s.platform = :ios, "7.0" #平台及版本
s.ios.deployment_target = "7.0" #最低系统版本
s.source = { :git => "https://github.com/TianyongWang/TYNetworkTool.git" ,:tag => "#{s.version}"} #工程地址及版本号
s.requires_arc = true #是否必须arc
s.source_files = "TYNetworkTool/*.{h,m}" #SDK实际的重要文件路径,这里有个坑,后面文章再说
s.frameworks = "UIKit","Foundation" #需要导入的frameworks名称,注意不要带上frameworks
s.dependency "AFNetworking" #依赖的第三方库
s.dependency "YYCache" #依赖的第三方库
end
-
添加podspec文件到GitHub.
git add 'SDK.podspec' 或者直接git add -A
git commit -m 'SDK.podspec'
git push -
添加LICENSE文件
vi LICENSE 直接复制个MIT就可以了
:wq
git add 'LICENSE' (或者git add )
git commit -m 'add LICENSE'
git push -
添加tag
git tag '0.0.1'
git add *
git commit -m 'add tag'
git push origin 0.0.1 -
使用 pod spec lint 来检测一下是否有错误或警告,有则改之,每次本地的工程中有改动并上传到GitHub上之后需要改变tag 否则就会找不到你所改动的,在改变了tag 之后需要将.podspec文件中的s.version和s.source 的tag 改成同样的值。这一步真是搞了好久,出了好多错误,虽然都一一解决了。。有时间单独列个文章方便后续解决吧。
-
pod spec lint 无错误则可以pod trunk push,收到发布成功提示了就可以了。
-
我试了下pod search SDK 来搜索自己建的SDK,居然搜不到。。然后用以下方法解决了。。估计是本地索引文件里没更新就搜不到,删除重建索引就可以了
删除~/Library/Caches/CocoaPods目录下的search_index.json文件
pod setup成功后会生成~/Library/Caches/CocoaPods/search_index.json文件。
终端输入rm ~/Library/Caches/CocoaPods/search_index.json
删除成功后再执行pod search
- pod install SDK 到自己的项目里愉快的使用吧
迭代更新时候需要的操作SDK
- 将新代码上传到GitHub
- 升级tag 也就是第8步
- 修改podspec对应的版本号,对应上一步的tag,有其他新增文件或者修改一并修改。
- 上传podspec,也就是第6步
- 检测一下podspec是否有错,即第9步,有错就改
- 无错就pod trunk push。