2013年7月16日 星期二

[分享] Node.js server & Github webhook combine

通常 deploy 有許多種方式,最簡單的方式就直接採用 web hook ,特別是在 github 裡面有支援這樣的模式,你只要到

github project  -> setting



就可以看到如下圖所示的方式



當然 github 預設提供了許多不同的 hook 方式給予大家做選擇,不過因為我只會最基本的 web hook ,就選用這個方式來進行吧。

設定 endpoint


web hook 原理就是,

當開發者 push code
web hook 啓動
會觸發某個 endpoint

在 web hook 裡面要設定的欄位就是一個很簡單,可以接收 POST 的 URL。
像這邊,我們可以設定

caesarchi.com/deploy

接著就是伺服器部分的設定了。(可以參考之前的文章起一個 server and route ,或者參考 Node.js 台灣社群協作電子書 )。

從 github 傳遞的訊息


透過 github webhook 他會透過 POST 的方式傳送資料,會帶過來一個名稱為 payload 的變數。
payload 傳送一串 JSON data 過來,因此可以透過 JSON.parse 還原回來原本漂亮的樣子。

裡面會帶來這次 push 上來的 commit, branch, files 等相關資訊,我們可以透過這些資訊來達到自己的目的。

待會將會提到這個部分。

另外如果自己目前沒有任何 server 但是想要測試 github webhook 丟過去的訊息為何!可以考慮使用 requestb.in,觀察 webhook 後收到的資訊。



web hook 的啓動


首先,就是在伺服器端需要新增一個 POST Route ,並且可以執行程式伺服器的 shell 程式 。
在 POST 接收到之後,我們可以透過 Node.js child process 的方式啓動另外一個 shell 指令,進行部署動作。

這邊提供一個簡單的 code pattern.


從上面的程式我們可以看到到,透過 JSON parse 的方式,可以把 github payload 還原回 Object 。接下來都可以直接採取 JS rule 進行判斷,作處理等。

另外透過 child_process 執行 shell 程式,然後進行版本更新,重新啓動 web server 。直接一次到達定位。

後記

透過 JavaScript / Node.js 的方式,可以更快地開發自己想要的模式以及程式,當然這邊還有地方可以精進。

例如這個因為是採用基本的 post 方式,所以會有安全性問題,其實可以加上認證,還有參考 github API 比對 commit 的方式進行認證,這都是方式之一。

相信這樣方便的方式,會讓更多人願意把程式開源,放到 github 這個好用的 code social platform 。

沒有留言:

張貼留言

Facebook