使用Gitee + Webhook自动化部署网站

TLDR#

NOTE
主要利用了 Gitee 的 Webhook 功能，当推送代码到 Gitee 时，Gitee会发送一条 POST 请求到指定的地址，只需要在服务器端编写响应程序即可实现自动化部署，流程图如下：
sequenceDiagram participant 开发者 participant Gitee participant 个人服务器开发者->>Gitee: 设置 Webhook 地址与 SecretKey 开发者->>Gitee: git push Gitee->>个人服务器: 触发 Webhook （POST请求）个人服务器->>个人服务器: 验证 token 个人服务器->>Gitee: 验证结果个人服务器->>个人服务器: 开始部署个人服务器->>开发者: 部署结果通知（飞书或微信）

步骤#

1. 编写在服务器自动部署项目的程序#

代码放在了文章末尾，主要流程是收到 Gitee 发出的 POST 请求后，编译项目并将输出的文件复制到网站根目录。这里的代码仅使用于使用 pnpm 进行构建的前端项目，如果是其他的项目，需要对 deploy() 函数进行修改。

2. 将服务器的公钥粘贴到 Gitee 中#

在服务器上执行下面的代码获取公钥，尽量不要使用 root 用户进行部署（这里选择的是 www 用户）。

1
cat /home/www/.ssh/id_rsa.pub

将公钥粘贴在 Gitee 对应项目的 部署公钥 中。

3. 在服务器上下载项目代码并编译#

将项目代码下载到服务器。

1
sudo -u www git clone <项目ssh地址>

初步编译一下项目，确保项目可以在服务器上正常编译。

1
# 使用pnpm安装依赖库
2
sudo -u www npx pnpm install
3

4
# 编译一下，确保编译过程正常
5
sudo -u www npx pnpm run build

4. 在服务器上启动部署程序#

NOTE
运行前需要安装 flask 库。
1
pip3 install  flask

在服务器上以 www 用户的身份运行部署程序。注意设置一个 SECRET_KEY ，Gitee 发送部署请求时需要携带该参数（可以随意设置，这里设置的是 test）。

1
sudo -u www SECRET_KEY=test python auto_deploy.py &

运行后执行下面的命令测试一下，如果部署成功，将输出 ok 。

1
curl 127.0.0.1:9999

5. 设置 Webhook#

进入 Gitee 的项目，点击管理-> webhooks -> 添加Webhook

输入基础信息并保存。

如果配置无误，点击 Webhook 页面的 测试 按钮，将显示 {"message":"Token is ok"}

6. 开始使用#

在使用 git push 上传代码后，稍等片刻，即可看到网站已更新。

代码#

auto_deploy.py

1
import os
2
import shutil
3
import subprocess
4
from flask import Flask, request, jsonify, after_this_request
5
import filecmp
6
import multiprocessing
7
import time
8
import hmac
9
import hashlib
10
import base64
11
import os
12

13

14
# 配置项
15

16
# 项目工作目录
17
WORKING_DIR = "/www/wwwroot/CLoudSirLab-Blog/blog-cloud-site"
18
# 网站部署目录
19
DEPLOY_DIR = "/www/wwwroot/cloudsir.top"
20
# 默认TOKEN
21
DEFAULT_SECRET_TOKEN = "test"
22

23
DEPLOYING = False
24
process_handler = None
25
retry = 0
26

27
def verify_signature(timestamp, sign):
28
    """
29
    验证签名函数
30
    :param timestamp: 时间戳（毫秒）
31
    :param sign: 需要验证的签名
32
    :return: bool，表示签名是否有效
33
    """
34
    # 从环境变量中获取密钥
35
    secret = os.getenv('SECRET_KEY', DEFAULT_SECRET_TOKEN)  # 如果环境变量未设置，则使用默认值
36
    secret_enc = secret.encode('utf-8')
37

38
    # 构造签名字符串
39
    string_to_sign = f'{timestamp}\n{secret}'
40
    string_to_sign_enc = string_to_sign.encode('utf-8')
41

42
    # 生成 HMAC 签名
43
    hmac_code = hmac.new(secret_enc, string_to_sign_enc, digestmod=hashlib.sha256).digest()
44
    expected_sign = base64.b64encode(hmac_code).decode('utf-8')
45

46
    print("---HMAC---")
47
    print("timestamp: ", timestamp)
48
    print("secret: ", secret)
49
    print("sign: ", sign)
50
    print("expected_sign: ", expected_sign)
51
    print("---HMAC---")
52

53
    # 比较传入的签名和生成的签名
54
    return hmac.compare_digest(sign, expected_sign)
55

56

57
def deploy():
58
    global DEPLOYING
59
    global retry
60

61
    try:
62
        print("拉取最新代码")
63
        # 拉取最新代码
64
        subprocess.run(["git", "pull"], check=True)
65

66
        print("开始编译")
67
        # 编译项目
68
        build_result = subprocess.run(["npx", "pnpm", "run", "build"], check=True, capture_output=True, text=True)
69

70
        if build_result.returncode == 0:
71
            print("开始部署")
72

73
            # 将文件复制到部署目录
74
            dist_path = os.path.join(WORKING_DIR, "dist")
75
            deploy_path = DEPLOY_DIR
76
            sync_directories(dist_path, deploy_path)
77

78
            # 发送消息通知
79
            notify_me("Deployment completed successfully")
80
            DEPLOYING = False
81
        else:
82
            print("部署失败")
83
            # 部署失败
84
            error_message = build_result.stderr
85
            DEPLOYING = False
86

87
            print(error_message)
88

89
            if retry > 0:
90
                print("重新部署")
91
                retry = retry - 1
92
                deploy()
93
            else:
94
                notify_me(f"Deployment failed: {error_message}")
95

96
    except subprocess.CalledProcessError as e:
97
        error_message = str(e)
98
        DEPLOYING = False
99
        print(error_message)
100
        if retry > 0:
101
            print("重新部署")
102
            retry = retry - 1
103
            deploy()
104
        else:
105
            notify_me(f"Deployment failed: {error_message}")
106

107
# 通知函数（可以改造成飞书推送、微信推送）
108
def notify_me(s):
109
    print(s)
110

111
app = Flask(__name__)
112

113
@app.route('/'):
114
def test():
115
    return "ok"
116

117
@app.route('/webhook', methods=['POST'])
118
def webhook():
119
    global DEPLOYING
120
    global process_handler
121
    global retry
122

123
    # 获取请求头
124
    event_type = request.headers.get('X-Git-Oschina-Event')
125
    token = request.headers.get('X-Gitee-Token')
126
    timestamp = request.headers.get('X-Gitee-Timestamp')
127

128
    print(request.headers)
129

130
    # 逐个判断是否都存在
131
    if not event_type:
132
        return jsonify({"error": "event_type is missing"}), 400
133
    if not token:
134
        return jsonify({"error": "token is missing"}), 400
135
    if not timestamp:
136
        return jsonify({"error": "timestamp is missing"}), 400
137

138
    # 验证时间戳1分钟有效期
139
    timestamp_is_valid = time.time() - (int(timestamp) / 1000) < 60
140
    if not timestamp_is_valid:
141
        return jsonify({"error": "Timestamp is expired"}), 401
142

143
    # 验证token
144
    if not verify_signature(timestamp, token):
145
        print("Invalid signature")
146
        return jsonify({"error": "Invalid signature"}), 401
147

148
    # 验证事件类型
149
    if event_type == 'Push Hook':
150
        print("Push Hook")
151
    elif event_type == 'push_hooks':
152
        return jsonify({"message": "Token is ok"}), 200
153
    else:
154
        return jsonify({"error": "Invalid event type"}), 400
155

156
    # 切换工作目录
157
    os.chdir(WORKING_DIR)
158

159
    DEPLOYING = True
160

161
    if (process_handler is not None) and (process_handler.is_alive()):
162
        print("检测到正在运行的部署进程，尝试终止...")
163
        process_handler.terminate()
164
        process_handler.join()  # 等待进程终止
165
        print("旧部署进程已终止")
166

167
    print("开始部署")
168
    retry = 3
169
    process_handler = multiprocessing.Process(target=deploy)
170
    process_handler.start()
171

172
    return jsonify({"message": "Start Deploying"}), 200
173

174
def sync_directories(src, dst):
175
    """
176
    同步两个目录，确保 dst 目录与 src 目录一致，只更新变化的文件，删除多余的文件。
177
    """
178
    # 遍历 src 目录，更新或添加文件
179
    for root, dirs, files in os.walk(src):
180
        relative_path = os.path.relpath(root, src)
181
        target_path = os.path.join(dst, relative_path)
182

183
        # 确保目标目录存在
184
        if not os.path.exists(target_path):
185
            os.makedirs(target_path)
186

187
        for file in files:
188
            src_file = os.path.join(root, file)
189
            dst_file = os.path.join(target_path, file)
190

191
            # 如果目标文件不存在或内容不同，则更新文件
192
            if not os.path.exists(dst_file) or not filecmp.cmp(src_file, dst_file, shallow=False):
193
                shutil.copy2(src_file, dst_file)
194

195
    # 遍历 dst 目录，删除多余的文件和目录
196
    for root, dirs, files in os.walk(dst, topdown=False):
197
        relative_path = os.path.relpath(root, dst)
198
        src_path = os.path.join(src, relative_path)
199

200
        for file in files:
201
            dst_file = os.path.join(root, file)
202
            src_file = os.path.join(src_path, file)
203

204
            # 如果目标文件在 src 中不存在，则删除
205
            if not os.path.exists(src_file) and not src_file.endswith(".user.ini"):
206
                os.remove(dst_file)
207

208
        for dir in dirs:
209
            dst_dir = os.path.join(root, dir)
210
            src_dir = os.path.join(src_path, dir)
211

212
            # 如果目标目录在 src 中不存在，则删除
213
            if not os.path.exists(src_dir):
214
                shutil.rmtree(dst_dir)
215

216
if __name__ == '__main__':
217
    app.run(host='0.0.0.0', port=9999)