創(chuàng)建自己的CocoaPods庫并提交指南

來自我的個(gè)人博客Minecode.link

前言

CocoaPods是一款很棒的依賴管理工具,在開發(fā)中也經(jīng)常用它來導(dǎo)入開源第三方庫。最近也想把自己的一些庫開源并加入CocoaPods中,特總結(jié)一下自己制作CocoaPods庫的過程。

前提

在制作之前,你需要:

  • 掌握CocoaPods的基本使用
  • 掌握Git的簡單使用
  • 準(zhǔn)備好自己要開源的成品

開始制作

下面我們開始制作自己的開源庫,以個(gè)人的MCScratchImageView為例。

推送至Git倉庫(Github)

首先需要將你的開源框架上傳至遠(yuǎn)程倉庫,比如Github,使用方式不再贅述。記錄下你要使用的commit版本對應(yīng)的SHA值。如下圖:

SHA Code

為所選版本打tag

在Github自帶tag功能

在Github上為項(xiàng)目打tag可在release頁面,選擇創(chuàng)建新tag并按下圖所示填寫即可。刪除tag也同理。
由于CocoaPods的版本信息僅支持?jǐn)?shù)字的格式(如1.0.0),所以版本號(hào)請勿帶有其他特殊符號(hào)和字母。


Tag on Github

使用命令行

使用命令行進(jìn)行版本管理較為方便,簡單步驟為: 創(chuàng)建本地tag -> 將tag推至遠(yuǎn)程倉庫。

參考如下代碼:

// 創(chuàng)建本地tag
git tag -a 1.0.0 0c3b62d -m "Release Edition v1.0.0"
// 同步到遠(yuǎn)程倉庫
git push origin 1.0.0

具體Tag的使用方式,可以參考使用Git添加tag的方法

制作Podspec描述文件

生成Podspec

首先在項(xiàng)目主目錄輸入一下命令
pod spec create <你的項(xiàng)目名>

該命令會(huì)在目錄中生成一個(gè).podspec格式的文件,包含了該框架的詳細(xì)信息,我們創(chuàng)建CocoaPods庫的所有配置都圍繞它來完成。

配置Podspec文件

使用編輯工具(如SublimeText)打開該podspec文件,文檔中已經(jīng)有詳細(xì)描述,在此簡單說明一下各屬性作用:

s.name: 框架名稱

s.version: 框架最新版本號(hào)。這個(gè)版本號(hào)對應(yīng)了你Git倉庫中某個(gè)提交的tag,如果倉庫中對應(yīng)的tag不存在則會(huì)提交失敗。

s.summary: 框架的概述。
s.description: 框架的詳細(xì)介紹。
s.homepage: 框架對應(yīng)頁面,隨便寫
s.license: 框架的開源協(xié)議
s.author: 框架作者及郵箱,設(shè)置方式見注釋

s.platform: 這個(gè)要按注釋寫清支持的系統(tǒng)和版本,同時(shí)也要保證實(shí)際情況,比如Swift3.0最低支持到iOS 8.0,你就不能寫最低支持iOS 7.0

s.source: 對應(yīng)的git源,在Github->Clone or download->Clone with HTTPS中

Git source

s.source_files: 庫的源代碼文件。這個(gè)是重點(diǎn),應(yīng)該包含全部你的庫所需的文件。
"s.source_files = MCScratchImageView/*.swift"為MCScratchImageView文件夾內(nèi)的全部swift代碼文件。注意默認(rèn)為.h和.m文件,需要設(shè)置為swift的格式??梢栽O(shè)置多個(gè)文件參數(shù)。

s.framework: 項(xiàng)目所用到的原生框架,如UIKit Framework

s.dependency: 項(xiàng)目需要的其他CocoaPods庫,如s.dependency "JSONKit", "~> 1.4"

驗(yàn)證Podspec文件

配置完P(guān)odspec文件之后,我們可以預(yù)先驗(yàn)證一下文件是否可用。

pod spec lint <文件名稱>.podspec

若提示<文件名> passed validation.,則驗(yàn)證通過。

發(fā)布到CocoaPods(Trunk方式)

完成了所有的制作之后,我們現(xiàn)在將庫發(fā)布到CocoaPods。使用了其自帶的Trunk工具進(jìn)行提交。

注冊Trunk

首先需要將本機(jī)注冊到trunk

pod trunk register <E-mail> '<用戶名>' --description='<設(shè)備別名>'

提交注冊后,所填寫的郵箱將會(huì)收到一個(gè)驗(yàn)證郵件,確認(rèn)驗(yàn)證即可。

同時(shí)也可以為項(xiàng)目添加其他維護(hù)者:

pod trunk add-owner <庫名> <其他維護(hù)者郵箱>

可以使用pod trunk me來查看當(dāng)前賬戶信息。

使用Trunk提交

通過配置好的Podspec,我們可以將庫提交到CocoaPods上。使用以下命令:

pod trunk push <文件名>.podspec

提交過程會(huì)檢查你的代碼能否正確編譯、以及Podspec是否正確配置。若成功將會(huì)顯示祝賀信息。

查看提交庫信息

我們可以在提交成功后查看是庫是否已經(jīng)在CocoaPods上,命令如下:

pod search <庫名>
// 如果查找不到,可以嘗試
pod search <庫名> --simple

如果找不到,可以嘗試

pod setup
rm ~/Library/Caches/CocoaPods/search_index.json

如果能查看到庫信息,則說明上傳成功。我們可以看到庫的介紹以及所有版本等信息。

刪除庫的指定版本

當(dāng)上傳的庫版本號(hào)已存在時(shí)會(huì)發(fā)生沖突,不能覆蓋。所以我們只能先刪除指定版本再重新提交。

pod trunk delete <庫名> <版本號(hào)>

示例

至此,我們已經(jīng)成功把自己的庫提交至CocoaPods,用戶可以通過Podfile來使用。
下面附一份本人CocoaPods庫的Podspec文件以供參考, MCScratchImageView

Pod::Spec.new do |s|
s.name         = "MCScratchImageView"
s.version      = "1.0.0"
s.summary      = "Custom ImageView like scratch card"
s.description  = <<-DESC
A custom ImageView that is used to cover the surface of other view like a scratch card, user can swipe the mulch to see the view below.
DESC
s.homepage     = "https://github.com/Minecodecraft/MCScratchImageView"
s.license      = "MIT"
s.author       = { "Minecode" => "Minecoder@163.com" }
s.platform     = :ios, "8.0"
s.source       = { :git => "https://github.com/Minecodecraft/MCScratchImageView.git", :tag => "#{s.version}" }
s.source_files  = "MCScratchImageView/MCScratchImageView.swift"
s.framework  = "UIKit"
end

如有問題,可以發(fā)送郵件至 minecoder@163.com
歡迎共同探討iOS開發(fā)問題

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容