使用 GitHub 和 Python 实现持续部署(2)

当前位置:

首先代码创建了一个新的蓝图 webhook。然后它使用 Flask route 为蓝图添加了一个端点。任何请求 /GitHub URL 端点的 POST 请求都将调用这个路由。

当服务在该端点上接到请求时，首先它必须验证该请求是否来自 GitHub 以及来自正确的仓库。GitHub 在请求头的 X-Hub-Signature 中提供了一个签名。该签名由一个密码（GITHUB_SECRET），请求体的 HMAC 十六进制摘要，并使用 sha1 哈希生成。

为了验证请求，服务需要在本地计算签名并与请求头中收到的签名做比较。这可以由 hmac.compare_digest 函数完成。

在验证请求后，现在就可以处理了。这篇教程使用 GitPython 模块来与 git 仓库进行交互。GitPython 模块中的 Repo 对象用于访问远程仓库 origin。该服务在本地拉取 origin 仓库的最新更改，还用 --rebase 选项来避免合并的问题。

调试打印语句显示了从请求体收到的短提交哈希。这个例子展示了如何使用请求体。更多关于请求体的可用数据的信息，请查询 GitHub 文档。

最后该服务返回了一个空的 JSON 字符串和 200 的状态码。这用于告诉 GitHub 的网络钩子服务已经收到了请求。

为了运行该服务，这个例子使用 gunicorn web 服务器。首先安装服务依赖。在支持的 Fedora 服务器上，以 sudo 运行这条命令:

1	`sudo` `dnf` `install` `python3-gunicorn python3-flask python3-GitPython`

现在编辑 gunicorn 使用的 wsgi.py 文件来运行该服务：

1 2	`from app` `import` `create_app` `application = create_app()`

为了部署服务，使用以下命令克隆这个 git 仓库或者使用你自己的 git 仓库：

1	`git clone https://github.com/cverna/github_hook_deployment.git` `/opt/`

下一步是配置服务所需的环境变量。运行这些命令：

1 2	`export` `GITHUB_SECRET=asecretpassphraseusebygithubwebhook` `export` `REPO_PATH=/opt/github_hook_deployment/`

这篇教程使用网络钩子服务的 GitHub 仓库，但你可以使用你想要的不同仓库。最后，使用这些命令开启该 web 服务：

1 2	`cd` `/opt/github_hook_deployment/` `gunicorn --bind 0.0.0.0 wsgi:application --reload`

这些选项中绑定了 web 服务的 IP 地址为 0.0.0.0，意味着它将接收来自任何的主机的请求。选项 --reload 确保了当代码更改时重启 web 服务。这就是持续部署的魔力所在。每次接收到 GitHub 请求时将拉取仓库的最近更新，同时 gunicore 检测这些更改并且自动重启服务。

*注意： *为了能接收到 GitHub 请求，web 服务必须部署到具有公有 IP 地址的服务器上。做到这点的简单方法就是使用你最喜欢的云提供商比如 DigitalOcean，AWS，Linode等。

这篇教程的最后一部分是配置 GitHub 来发送网络钩子请求到 web 服务上。这是持续部署的关键。

从你的 GitHub 仓库的设置中，选择 Webhook 菜单，并且点击“Add Webhook”。输入以下信息：

“Payload URL”：服务的 URL，比如<http://public_ip_address:8000/github>

“Content type”：选择 “application/json”

“Secret”：前面定义的 GITHUB_SECRET 环境变量

然后点击“Add Webhook” 按钮。

现在每当该仓库发生推送事件时，GitHub 将向服务发送请求。

栏目列表