Chappy是使用GitHub Webhooks部署網站的最簡單方法。
定義一個項目和部署腳本進行運行,Chappy將聆聽對您的GitHub存儲庫的更改並自動部署。它非常適合小型部署,例如單個Digitalocean服務器❄️
作業系統 |
---|
Linux X64 |
Maxos(10.7及以上) |
Windows X64 |
Windows X32 |
build
文件夾中不同類型的操作系統還有更多選項。
首先,請下載正確的操作系統可執行文件,然後將其移至$PATH
中的目錄。例如在Linux X64上:
$ mv chappy-linux-amd64 chappy
$ chmod +x chappy
$ sudo mv chappy /usr/local/bin/chappy
❓問題?您可以讀取有關Linux,Mac和Windows的逐步安裝說明。
下一步是創建一個項目文件,該文件將定義您要用於一個或多個存儲庫的Webhooks。首先,在您的家庭或www目錄中創建一個空的projects.json
文件。讓我們定義一個名為MyWebsite
的項目,該項目將運行位於/var/www/MyWebsite/deploy.sh
中的部署腳本。
[
{
"name" : " MyWebsite " ,
"branch" : " master " ,
"script" : " /var/www/MyWebsite/deploy.sh " ,
"secret" : " <SECRET> "
}
]
?為了確保只有GitHub可以運行您的Webhook,每個項目都應具有獨特的秘密字符串。您可以通過運行chappy secret
或使用隨機密碼生成器來快速生成一個隨機的32字符串 - 無論哪種方式,請確保替換<SECRET>
。
您的部署腳本應該是可執行的腳本(請確保chmod +x deploy.sh
)。以最基本的形式,它應該運行git pull
,以通過最新更改更新回購。下面的示例使用作曲家和NPM安裝任何新的依賴項,並使用Gulp安裝資產。
#! /bin/bash
git pull
composer install
npm install
gulp --production
帶有事件詳細信息的參數傳遞給腳本,該腳本可動態運行命令。在部署腳本頁面上有一些更高級的部署腳本示例,顯示瞭如何使用此功能。
您現在可以開始使用Chappy
$ chappy start
⚙檢查CLI頁面以查看可用的命令列表,如何配置Chappy運行的IP和端口,並啟用其他設置,例如熱加載項目文件或通過HTTPS服務。
在您的github存儲庫中添加一個新的Webhook,可以在設置 - > webhooks->添加webhook中找到。
http://123.456.0.1:9000/MyWebsite
。application/json
,但可以是任何內容。projects.json
中定義的秘密字符串。push
事件。⏰即將來臨 - Chappy將登錄到文件,讓您知道是否有任何問題 - 並聆聽GitHub ping
事件,以跳過必須進行測試提交。
要測試一切成功運行,請對主分支進行測試提交或提取請求( "Beep, Boop! - Testing Chappy ?"
如果Webhook沒有錯誤完成並且您的腳本運行正確,則恭喜?如果有錯誤,請閱讀故障排除頁面或提交問題。 ?
要在背景中運行Chappy,請按照以下步驟進行逐步指南:
誰是一個好男孩?