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,请按照以下步骤进行逐步指南:
谁是一个好男孩?