如何創建一個GitLab Web Hooks?

如何創建一個GitLab Web Hooks?

Git Hooks

Git 能在特定的重要動作發生時觸發自定義的腳本。

這些腳本都被存儲在 Git 目錄下的 hooks 子目錄中( .git/hooks )。當 git init 初始化一個倉庫時,Git 默認會在這個目錄中放置一些示例腳本。這些腳本一般都是 shell 腳本。不過自定義的可執行腳本可以使用你喜歡的腳本語言,如 Ruby、 Python 等。

這些示例的名字都是以 .sample 結尾,如果需要啟用它們,首先要移除這個後綴:

<code>cd .git/hooks
ls/<code>
<code>applypatch-msg.sample
commit-msg.sample
post-update.sample
pre-applypatch.sample
pre-commit.sample
pre-push.sample
pre-rebase.sample
prepare-commit-msg.sample
update.sample/<code>
<code>cp applypatch-msg.sample applypatch-msg/<code>

鉤子按功能分來兩類:客戶端和和服務器端的。

客戶端鉤子由諸如提交(commit)和合並(merge)這樣的操作所調用,而服務器端鉤子作用於諸如接收被推送(push)的提交這樣的聯網操作。

GitLab Web Hooks

如何創建一個GitLab Web Hooks?

顧名思義,Web Hooks 的含義是將本地腳本接口化。GitLab 能在特定的重要動作發生時調用自定義的接口。接口的內部邏輯實現自動化部署或自動化測試的代碼。

搭建接口服務

以 nginx + supervisor 部署 flask 應用作為我們的接口服務。

基於 flask 框架搭建接口服務

創建 python 文件:

<code>vi web_hooks_flask.py/<code>

寫入以下代碼:

<code>#! /usr/bin/env python
# -*- coding: utf-8 -*-

from flask import Flask, request
import json
import os

app = Flask(__name__)

@app.route('/', methods=['POST'])
def index():
path = '/home/www/test/' # 項目目錄
return _hooks(path, request.data)

def _hooks(path, data):
post_data = json.loads(data)
ref = post_data['ref']
branch_name = ref.split('/')[-1]
status = os.system("cd %s && git checkout %s && git pull --rebase" % (path, branch_name,))
if status == 0:
return 'success'
else:
return 'error'


if __name__ == '__main__':
app.debug = True
app.run()/<code>

保存後,啟動服務:

<code>python web_hooks_flask.py/<code>

啟動成功:

<code>* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger pin code: 569-323-263/<code>

supervisor 管理進程

supervisor 是一個進程管理程序,能將一個普通的命令行進程變為守護進程,並監控進程狀態,異常退出時能自動重啟。

在 supervisor 的配置文件中追加:

<code>[program:web_hooks_flask]
command=python /path/web_hooks_flask.py # path 改為具體部署的絕對路徑
redirect_stderr=true
stdout_logfile=/path/web_hooks_flask.log # path 改為具體部署的絕對路徑/<code>

更新配置文件:

<code>supervisorctl update/<code>

啟動進程:

<code>supervisorctl start web_hooks_flask/<code>

查看進程:

<code>supervisorctl/<code>
<code>web_hooks_flask   RUNNING   pid 29526, uptime 2 days, 20:58:51/<code>

nginx 作為反向代理服務器

向 nginx 配置文件中追加配置:

<code>server {
listen 80;
server_name hooks.test.com; # 修改為服務器的ip或域名
location / {
proxy_pass http://127.0.0.1:5000; # 反向代理
}
}/<code>

重啟 nginx 服務。

在 GitLab 中配置 web hooks

如何創建一個GitLab Web Hooks?

在上圖的URL中,填入 hooks.test.com 保存即可。


分享到:


相關文章: