EEPW论坛

首先借助GitHub的网络钩子webhook，开发者可以创建很多有用的服务。从触发一个Jenkins实例上的CI（持续集成）任务到配置云中的机器，几乎有着无限的可能性。这篇教程将展示如何使用Python和Flask框架来搭建一个简单的持续部署（CD）服务。

在这个例子中的持续部署服务是一个简单的Flask应用，其带有接受GitHub的网络钩子webhook请求的REST端点endpoint。在验证每个请求都来自正确的GitHub仓库后，服务器将拉取pull更改到仓库的本地副本。这样每次一个新的提交commit推送到远程GitHub仓库，本地仓库就会自动更新。

Flaskweb服务

用Flask搭建一个小的web服务非常简单。这里可以先看看项目的结构。

├──app
│├──__init__.py
│└──webhooks.py
├──requirements.txt
└──wsgi.py

首先，创建应用。应用代码在app目录下。

两个文件（__init__.py和webhooks.py）构成了Flask应用。前者包含有创建Flask应用并为其添加配置的代码。后者有端点endpoint逻辑。这是该应用接收GitHub请求数据的地方。

这里是app/__init__.py的内容：

　　importos
　　fromflaskimportFlask
　　from.webhooksimportwebhook
　　defcreate_app():
　　"""Create,configureandreturntheFlaskapplication"""
　　app=Flask(__name__)
　　app.config['GITHUB_SECRET']=os.environ.get('GITHUB_SECRET')
　　app.config['REPO_PATH']=os.environ.get('REPO_PATH')
　　app.register_blueprint(webhook)
　　return(app)

该函数创建了两个配置变量：

GITHUB_SECRET保存一个密码，用来认证GitHub请求。

REPO_PATH保存了自动更新的仓库路径。

这份代码使用Flask蓝图FlaskBlueprints来组织应用的端点endpoint。使用蓝图可以对API进行逻辑分组，使应用程序更易于维护。通常认为这是一种好的做法。

这里是app/webhooks.py的内容：

　　importhmac
　　fromflaskimportrequest,Blueprint,jsonify,current_app
　　fromgitimportRepo
　　webhook=Blueprint('webhook',__name__,url_prefix='')
　　@webhook.route('/github',methods=['POST'])
　　defhandle_github_hook():
　　"""Entrypointforgithubwebhook"""
　　signature=request.headers.get('X-Hub-Signature')
　　sha,signature=signature.split('=')
　　secret=str.encode(current_app.config.get('GITHUB_SECRET'))
　　hashhex=hmac.new(secret,request.data,digestmod='sha1').hexdigest()
　　ifhmac.compare_digest(hashhex,signature):
　　repo=Repo(current_app.config.get('REPO_PATH'))
　　origin=repo.remotes.origin
　　origin.pull('--rebase')
　　commit=request.json['after'][0:6]
　　print('Repositoryupdatedwithcommit{}'.format(commit))
　　returnjsonify({}),200

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

验证请求

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

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

自定义钩子逻辑

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

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

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

部署服务

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

sudodnfinstallpython3-gunicornpython3-flaskpython3-GitPython

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

fromappimportcreate_app

application=create_app()

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

gitclone：github/cverna/github_hook_deployment.git/opt/

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

exportGITHUB_SECRET=asecretpassphraseusebygithubwebhook

exportREPO_PATH=/opt/github_hook_deployment/

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

cd/opt/github_hook_deployment/

gunicorn--bind0.0.0.0wsgi:application--reload

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

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

配置GitHub

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

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

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

“Contenttype”：选择“application/json”

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

然后点击“AddWebhook”按钮。

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

这篇教程向你展示了如何写一个基于Flask的用于接收GitHub的网络钩子请求，并实现持续集成的web服务。现在你应该能以本教程作为起点来搭建对自己有用的服务。