跳到主要內容

[分享] 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 。

留言

這個網誌中的熱門文章

[分享] 腳踏車環島注意事項

很多人都期望自己能夠做點什麼,做些什麼,而退伍之後的第二個星期,就展開了環島之旅。 對很多人來說這不算什麼,甚至有人展開了走路、跑步、溜滑板、單輪車等方式環島一周,充分展現對台灣的愛與關懷。 這篇主要讓不知道怎麼準備環島的人,作一個完善的解說,首先隨身的東西要有: 證件現金類 : 身份證 健保卡 學生證 現金 提款卡 悠遊卡

館長的網站技術瓶頸,小弟弟來解答 - notorious-2019.com

館長的網站技術瓶頸,小弟弟來解答 - notorious-2019.com 昨天看到館長的網站倒了,也看到館長說一個月花費大概一百萬左右的月費在支持這個架設的電商網站,也對外發布出來訊息,希望求救, 直接講結論 建議解法, 1. 首先要做的事情是讓整個網站可以橫向擴展 (Load Balancer + n 台伺服器),對,相信我,IIS 也是可以做 Scale out, 這是對於 Application layer 服務的解法。 2. 資料的部分 SQL 吞吐量,建議改成 GCP Cloud SQL, 或者就直接轉到 Azure SQL Server 環境上會相對容易解決 SQL 的問題。 上述 2 個步驟都處理完,其實 100 萬的費用,應該 20000 concurrent user 是沒有問題的,但前提是要設定『對』! 額外需要花較長期時間要處理的,建議就是在 Queue 的處理,購物車的狀態都可以進入到 Queue 再來處理 SQL insert 的問題,減少不斷的 insert / update 的狀態,後文會提到 ... 底下詳細的會再說明如何後後續還有哪些處理的細節。 這兩天剛好有個小空擋,就來分析一下狀況, 可以從外部讀取得到的服務大致上如下, ASP.Net : 4.0 IIS 10 + Windows (廢話) SQL Server (推測) OP Service: PleskWin Host: Google Cloud DNS: Cloudflare 前端服務內容架構 Server-side render, jQuery base, 推測有可能採用現成購物車來進行,看起來不太像是用 wooCommerce 比較像是 Cart Functionality 這類的項目直接搭建而成(當然這純屬猜測) 功能拆解 因為網站是透過 Server site render 所有頁面都需要重新透過伺服器進行載入,這樣的狀況,如果在頻繁忙碌的 eCommerce 網站架構下會是一個致命傷, 簡單來說,數量的查詢,特惠價,優惠碼等等資訊的處理,使用者每做一步都需要重新跳轉頁面,或者整頁面重新讀取,只是為了部分的資料更新,這些都可以抽取出來成為 API ,透過 AJAX 的方式進行讀取。 讀寫分離 在不了解目前資料庫複雜狀態下,首先要讓所有人都

[教學] 快快樂樂刪除CodeIgniter index.php

預設的CI網址預設都設定為index.php同一層級,因此所有的程式都必須指定index.php導向才能開始,例如 http://localhost/ci/index.php/welcome/test http://localhost/ci/welcome/test 本文將說明如何將惱人的index.php消除,還你一個漂亮的URL。 設定開始: 接下來說明如何使用rewrite方式將惱人的index.php去除。 rewrite不清楚的人,煩請先自行google 首先要先確定Apache的 mod_rewrite 有 開啟 ,如果沒有開啟請設定好之後重新啟動apache。 接著,在根目錄底下建立一個新檔案,檔名為 .htaccess ,裡面程式碼如下: <IfModule mod_rewrite.c> RewriteEngine On RewriteBase / RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d RewriteRule ^(.*)$ index.php/$1 [L] </IfModule> 接著到 application/config/config.php ,開啟檔案修改 $config['index_page'] = ""; 注意: /index.php/$1 要根據你目錄,例如 http://localhost/index.php ,網站根目錄為 /ci/index.php 則要寫成 /ci/index.php/$1 接著至CI目錄下,尋找 config\config.php , 修改一下裡面的檔案,修改如下: $config['index_page'] = ""; 存檔後,如此一來大功告成。 參考資料 官方網站說明