創建自己的CocoaPods庫并提交指南

來自我的個人博客Minecode.link

前言

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

前提

在制作之前,你需要:

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

開始制作

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

推送至Git倉庫(Github)

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

SHA Code

為所選版本打tag

在Github自帶tag功能

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


Tag on Github

使用命令行

使用命令行進行版本管理較為方便,簡單步驟為: 創建本地tag -> 將tag推至遠程倉庫。

參考如下代碼:

// 創建本地tag
git tag -a 1.0.0 0c3b62d -m "Release Edition v1.0.0"
// 同步到遠程倉庫
git push origin 1.0.0

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

制作Podspec描述文件

生成Podspec

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

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

配置Podspec文件

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

s.name: 框架名稱

s.version: 框架最新版本號。這個版本號對應了你Git倉庫中某個提交的tag,如果倉庫中對應的tag不存在則會提交失敗。

s.summary: 框架的概述。
s.description: 框架的詳細介紹。
s.homepage: 框架對應頁面,隨便寫
s.license: 框架的開源協議
s.author: 框架作者及郵箱,設置方式見注釋

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

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

Git source

s.source_files: 庫的源代碼文件。這個是重點,應該包含全部你的庫所需的文件。
"s.source_files = MCScratchImageView/*.swift"為MCScratchImageView文件夾內的全部swift代碼文件。注意默認為.h和.m文件,需要設置為swift的格式。可以設置多個文件參數。

s.framework: 項目所用到的原生框架,如UIKit Framework

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

驗證Podspec文件

配置完Podspec文件之后,我們可以預先驗證一下文件是否可用。

pod spec lint <文件名稱>.podspec

若提示<文件名> passed validation.,則驗證通過。

發布到CocoaPods(Trunk方式)

完成了所有的制作之后,我們現在將庫發布到CocoaPods。使用了其自帶的Trunk工具進行提交。

注冊Trunk

首先需要將本機注冊到trunk

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

提交注冊后,所填寫的郵箱將會收到一個驗證郵件,確認驗證即可。

同時也可以為項目添加其他維護者:

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

可以使用pod trunk me來查看當前賬戶信息。

使用Trunk提交

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

pod trunk push <文件名>.podspec

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

查看提交庫信息

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

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

如果找不到,可以嘗試

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

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

刪除庫的指定版本

當上傳的庫版本號已存在時會發生沖突,不能覆蓋。所以我們只能先刪除指定版本再重新提交。

pod trunk delete <庫名> <版本號>

示例

至此,我們已經成功把自己的庫提交至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

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

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370

推薦閱讀更多精彩內容