这篇教程将展示如何使用 Python 和 Flask 框架来搭建一个简单的持续部署(CD)服务。
-- Clément Verna
致谢
编译自 | https://fedoramagazine.org/continuous-deployment-github-python/
作者 | Clément Verna
译者 | kimii 共计翻译:10篇 贡献时间:139 天
借助 GitHub 的网络钩子webhook,开发者可以创建很多有用的服务。从触发一个 Jenkins 实例上的 CI(持续集成) 任务到配置云中的机器,几乎有着无限的可能性。这篇教程将展示如何使用 Python 和 Flask 框架来搭建一个简单的持续部署(CD)服务。
在这个例子中的持续部署服务是一个简单的 Flask 应用,其带有接受 GitHub 的网络钩子webhook请求的 REST端点endpoint。在验证每个请求都来自正确的 GitHub 仓库后,服务器将拉取pull更改到仓库的本地副本。这样每次一个新的提交commit推送到远程 GitHub 仓库,本地仓库就会自动更新。
Flask web 服务
用 Flask 搭建一个小的 web 服务非常简单。这里可以先看看项目的结构。
首先,创建应用。应用代码在 目录下。
两个文件( 和 )构成了 Flask 应用。前者包含有创建 Flask 应用并为其添加配置的代码。后者有端点endpoint逻辑。这是该应用接收 GitHub 请求数据的地方。
这里是 的内容:
该函数创建了两个配置变量:
◈ 保存一个密码,用来认证 GitHub 请求。
◈ 保存了自动更新的仓库路径。
这份代码使用Flask 蓝图Flask Blueprints
[1]
来组织应用的端点endpoint。使用蓝图可以对 API 进行逻辑分组,使应用程序更易于维护。通常认为这是一种好的做法。
这里是 的内容:
首先代码创建了一个新的蓝图 。然后它使用 Flask 为蓝图添加了一个端点。任何请求 URL 端点的 POST 请求都将调用这个路由。
验证请求
当服务在该端点上接到请求时,首先它必须验证该请求是否来自 GitHub 以及来自正确的仓库。GitHub 在请求头的 中提供了一个签名。该签名由一个密码(),请求体的 HMAC 十六进制摘要,并使用 哈希生成。
为了验证请求,服务需要在本地计算签名并与请求头中收到的签名做比较。这可以由 函数完成。
自定义钩子逻辑
在验证请求后,现在就可以处理了。这篇教程使用GitPython
[2]
模块来与 git 仓库进行交互。GitPython 模块中的 对象用于访问远程仓库 。该服务在本地拉取 仓库的最新更改,还用 选项来避免合并的问题。
领取专属 10元无门槛券
私享最新 技术干货