創(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)漩蟆,所以版本號請勿帶有其他特殊符號和字母。


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: 框架最新版本號。這個(gè)版本號對應(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的格式〉隽荆可以設(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)上傳的庫版本號已存在時(shí)會(huì)發(fā)生沖突纪他,不能覆蓋。所以我們只能先刪除指定版本再重新提交晾匠。

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

示例

至此茶袒,我們已經(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)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市句喜,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌沟于,老刑警劉巖咳胃,帶你破解...
    沈念sama閱讀 216,997評論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異旷太,居然都是意外死亡展懈,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,603評論 3 392
  • 文/潘曉璐 我一進(jìn)店門供璧,熙熙樓的掌柜王于貴愁眉苦臉地迎上來存崖,“玉大人,你說我怎么就攤上這事睡毒±淳澹” “怎么了?”我有些...
    開封第一講書人閱讀 163,359評論 0 353
  • 文/不壞的土叔 我叫張陵演顾,是天一觀的道長供搀。 經(jīng)常有香客問我,道長钠至,這世上最難降的妖魔是什么葛虐? 我笑而不...
    開封第一講書人閱讀 58,309評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮棉钧,結(jié)果婚禮上屿脐,老公的妹妹穿的比我還像新娘。我一直安慰自己宪卿,他們只是感情好的诵,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,346評論 6 390
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著佑钾,像睡著了一般奢驯。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上次绘,一...
    開封第一講書人閱讀 51,258評論 1 300
  • 那天瘪阁,我揣著相機(jī)與錄音撒遣,去河邊找鬼。 笑死管跺,一個(gè)胖子當(dāng)著我的面吹牛义黎,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播豁跑,決...
    沈念sama閱讀 40,122評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼廉涕,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了艇拍?” 一聲冷哼從身側(cè)響起狐蜕,我...
    開封第一講書人閱讀 38,970評論 0 275
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎卸夕,沒想到半個(gè)月后层释,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,403評論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡快集,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,596評論 3 334
  • 正文 我和宋清朗相戀三年贡羔,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片个初。...
    茶點(diǎn)故事閱讀 39,769評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡乖寒,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出院溺,到底是詐尸還是另有隱情楣嘁,我是刑警寧澤,帶...
    沈念sama閱讀 35,464評論 5 344
  • 正文 年R本政府宣布珍逸,位于F島的核電站马澈,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏弄息。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,075評論 3 327
  • 文/蒙蒙 一摹量、第九天 我趴在偏房一處隱蔽的房頂上張望涤伐。 院中可真熱鬧缨称,春花似錦山害、人聲如沸纠俭。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,705評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽冤荆。三九已至,卻和暖如春权纤,著一層夾襖步出監(jiān)牢的瞬間钓简,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,848評論 1 269
  • 我被黑心中介騙來泰國打工汹想, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留外邓,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,831評論 2 370
  • 正文 我出身青樓古掏,卻偏偏與公主長得像损话,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子冗茸,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,678評論 2 354

推薦閱讀更多精彩內(nèi)容