node 如何利用github中webhook進(jìn)行自動(dòng)化部署

前言

抱歉!你以為我要說(shuō)的是github! 其實(shí)我要說(shuō)的是碼云随常!

不過(guò)關(guān)系不大逆趋,在下的梯子掉了盏阶,訪問github實(shí)在慢的要死,標(biāo)題寫碼云我怕大家不認(rèn)識(shí)闻书。一句話解釋名斟,碼云就是中國(guó)的github,速度比較快魄眉!

這個(gè)教程的編寫主要是目前關(guān)于webhook的node版本的視頻教程和文字教程都沒有砰盐,而學(xué)會(huì)這個(gè)技能還是能大大提高效率的。做法是我自己瞎搞的做法杆融,可能不是很符合規(guī)范,但是自己的項(xiàng)目使用起來(lái)還是很爽的霜运,值得收藏脾歇。


原理

原先我們編寫一個(gè)項(xiàng)目的時(shí)候蒋腮,可能是在本地進(jìn)行開發(fā),然后上傳到github中藕各。接著進(jìn)入服務(wù)器中池摧,使用git pull origin 拉取下來(lái)。最后重新啟動(dòng)服務(wù)激况。

有的時(shí)候進(jìn)行一次更新操作是很費(fèi)時(shí)間的作彤。你可能為了要登錄服務(wù)器,進(jìn)入目錄乌逐,拉取代碼竭讳,有時(shí)候還要處理沖突,最后重新啟動(dòng)項(xiàng)目浙踢【盥快的話十幾分鐘,慢的話搞著搞著1個(gè)小時(shí)過(guò)去了洛波。

實(shí)際操作中胰舆,登錄服務(wù)器然后在服務(wù)器上的操作是比較費(fèi)時(shí)的,如果可以讓我們提交了代碼之后讓服務(wù)器自己拉取代碼并重新啟動(dòng)的話蹬挤,就可以省不少時(shí)間缚窿。

git系的遠(yuǎn)程倉(cāng)庫(kù)都有webhook功能,意思是可以讓你提交代碼之后順帶執(zhí)行一條請(qǐng)求焰扳。利用這一點(diǎn)我們可以在服務(wù)器中額外開啟一個(gè)服務(wù)用于自動(dòng)部署倦零。

image

流程如下:

  1. 本地更新代碼并push到倉(cāng)庫(kù)
  2. 倉(cāng)庫(kù)接受到push請(qǐng)求并執(zhí)行webhook請(qǐng)求,請(qǐng)求服務(wù)器中的自動(dòng)化部署服務(wù)蓝翰。
  3. 自動(dòng)化部署服務(wù)接受到請(qǐng)求光绕,在服務(wù)器端向倉(cāng)庫(kù)發(fā)送pull請(qǐng)求并部署。

演示

首先創(chuàng)建一個(gè)正在編寫的程序畜份,我們還是以egg的helloworld為例诞帐。

npm init egg --type=simple

在碼云中創(chuàng)建倉(cāng)庫(kù)并上傳這個(gè)代碼上去

項(xiàng)目地址: https://gitee.com/Zeeephr/auto-coding

然后在服務(wù)器中拉取下來(lái)。

這個(gè)作為你正在編寫的項(xiàng)目爆雹。

實(shí)現(xiàn)一個(gè)自動(dòng)化部署服務(wù)項(xiàng)目

腳本

#autoBuild.sh
npm run stop
git reset --hard origin/master
git clean -f
git pull
npm run start

web服務(wù)

var http = require('http')
var spawn = require('child_process').spawn
// 腳本地址
const script = '/xxx/xxx.sh';
// 執(zhí)行指令的地址
const currentPath = '/xxx/xxx';
const password = 'xxx';
http.createServer(function (req, res) {
  if(req.headers['x-gitee-token'] === password) {
    console.log('密碼正確 開始拉取代碼');
    rumCommand('sh', [script], function( txt ) {
      console.log(`在${currentPath}目錄下執(zhí)行了腳本${script}`);
      console.log(txt);
    });
    res.statusCode = 200;
    res.end('success');
  } else {
    res.statusCode = 200;
    res.end('???');
  }
}).listen(8889);
console.log('listen to 127.0.0.1:8889')

function rumCommand( cmd, args, callback ) {
  var child = spawn( cmd, args, {
    cwd: currentPath,
  } )
  var response = ''
  child.stdout.on('data', function( buffer ){ response += buffer.toString(); })
  child.stdout.on('end', function(){ callback( response ) })
}

這里我只做了最簡(jiǎn)單的實(shí)現(xiàn),這個(gè)服務(wù)監(jiān)聽8889服務(wù)停蕉,假設(shè)密碼為xxx。

  1. 需要注意的是代碼中的腳本位置設(shè)置為上面腳本的位置
  2. currentPath 設(shè)置為auto-coding的項(xiàng)目部署的位置钙态,這樣才會(huì)在改位置執(zhí)行g(shù)it pull慧起。這點(diǎn)其他的教程沒怎么提及。

代碼也上傳到碼云了: https://gitee.com/Zeeephr/auto-helper

將腳本和部署服務(wù)同樣部署到服務(wù)器中册倒,使用pm2 start app.js將服務(wù)常駐內(nèi)存蚓挤。

設(shè)置webhook

回到auto-coding項(xiàng)目,添加webhook操作。

設(shè)置指向的地址和密碼

測(cè)試連通性灿意。

其中success就是上面服務(wù)中返回的

    res.statusCode = 200;
    res.end('success');

測(cè)試整體流程

在本地中修改auto-coding項(xiàng)目代碼

至此我們就實(shí)現(xiàn)了自動(dòng)部署估灿。

后記

這里的auto-coding是一個(gè)公開項(xiàng)目,所以git pull的時(shí)候不需要密碼缤剧,如果是私有項(xiàng)目的時(shí)候是需要密碼的馅袁,沒有提供密碼的時(shí)候服務(wù)是無(wú)效的』脑可以在服務(wù)器中進(jìn)行設(shè)置記錄一下密碼汗销,具體搜索“l(fā)inux 設(shè)置github 免密碼”。這里不再贅述抵窒。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末弛针,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子估脆,更是在濱河造成了極大的恐慌钦奋,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,542評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件疙赠,死亡現(xiàn)場(chǎng)離奇詭異付材,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)圃阳,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門厌衔,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人捍岳,你說(shuō)我怎么就攤上這事富寿。” “怎么了锣夹?”我有些...
    開封第一講書人閱讀 163,912評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵页徐,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我银萍,道長(zhǎng)变勇,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,449評(píng)論 1 293
  • 正文 為了忘掉前任贴唇,我火速辦了婚禮搀绣,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘戳气。我一直安慰自己链患,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,500評(píng)論 6 392
  • 文/花漫 我一把揭開白布瓶您。 她就那樣靜靜地躺著麻捻,像睡著了一般纲仍。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上贸毕,一...
    開封第一講書人閱讀 51,370評(píng)論 1 302
  • 那天巷折,我揣著相機(jī)與錄音,去河邊找鬼崖咨。 笑死,一個(gè)胖子當(dāng)著我的面吹牛油吭,可吹牛的內(nèi)容都是我干的击蹲。 我是一名探鬼主播,決...
    沈念sama閱讀 40,193評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼婉宰,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼歌豺!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起心包,我...
    開封第一講書人閱讀 39,074評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤类咧,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后蟹腾,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體痕惋,經(jīng)...
    沈念sama閱讀 45,505評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,722評(píng)論 3 335
  • 正文 我和宋清朗相戀三年娃殖,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了值戳。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,841評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡炉爆,死狀恐怖堕虹,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情芬首,我是刑警寧澤赴捞,帶...
    沈念sama閱讀 35,569評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站郁稍,受9級(jí)特大地震影響赦政,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜艺晴,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,168評(píng)論 3 328
  • 文/蒙蒙 一昼钻、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧封寞,春花似錦然评、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春亿眠,著一層夾襖步出監(jiān)牢的瞬間碎罚,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工纳像, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留荆烈,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,962評(píng)論 2 370
  • 正文 我出身青樓竟趾,卻偏偏與公主長(zhǎng)得像憔购,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子岔帽,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,781評(píng)論 2 354

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