如何将Code Beamer工单ID及状态与GitLab集成并实现提交验证？

核心实现逻辑 #

利用GitLab的**预接收钩子（pre-receive hook）**拦截代码推送请求，在钩子脚本中完成三个关键动作：提取提交信息中的Code Beamer工单ID、调用Code Beamer API查询工单状态、验证状态是否为OPEN，只有验证通过才允许推送。

具体步骤 #

1. 统一提交信息规范 #

要求开发者必须在提交信息中包含Code Beamer工单ID，采用固定格式：CB-1234: 修复支付流程超时问题，其中CB-为工单ID的识别前缀，方便脚本精准提取。

2. 编写预接收钩子脚本 #

预接收钩子是GitLab仓库服务器端的可执行脚本，存放在仓库的hooks目录（Omnibus版本路径通常为/var/opt/gitlab/git-data/repositories/<组名>/<项目名>.git/hooks/pre-receive），需赋予可执行权限。

以下是bash+curl实现的核心脚本：

#!/bin/bash

# Code Beamer 配置项
CODEBEAMER_BASE_URL="http://你的Code Beamer实例地址"
API_AUTH_TOKEN="你的Code Beamer API令牌"
ALLOWED_STATUS="OPEN"

# 遍历推送的所有提交记录
while read old_rev new_rev ref_name; do
    # 获取本次推送的所有提交哈希
    for commit_hash in $(git rev-list $old_rev..$new_rev); do
        # 提取提交信息
        commit_message=$(git log --format=%B -n 1 $commit_hash)
        # 匹配工单ID（正则匹配CB-开头的数字ID）
        if [[ $commit_message =~ CB-([0-9]+) ]]; then
            ticket_id=${BASH_REMATCH[1]}
            # 调用Code Beamer API查询工单状态
            ticket_status=$(curl -s -H "Authorization: Bearer $API_AUTH_TOKEN" \
                "$CODEBEAMER_BASE_URL/api/v3/tickets/$ticket_id" | \
                jq -r '.status.name')  # 假设API返回JSON结构，用jq解析状态字段
            
            # 验证工单状态
            if [[ "$ticket_status" != "$ALLOWED_STATUS" ]]; then
                echo "❌ 推送失败：工单CB-$ticket_id的状态为$ticket_status，仅允许OPEN状态的工单推送"
                exit 1
            fi
        else
            echo "❌ 推送失败：提交信息中未包含有效的Code Beamer工单ID（格式要求：CB-XXXX）"
            exit 1
        fi
    done
done

# 所有验证通过，允许推送
exit 0

3. 配置Code Beamer API权限 #

• 在Code Beamer中创建专用服务账号，授予工单查询权限
• 生成该账号的API令牌（通常在用户设置的「API Tokens」选项中创建）

4. 部署钩子到GitLab #

• 将脚本上传至目标仓库的hooks目录，并重命名为pre-receive
• 执行chmod +x pre-receive赋予脚本可执行权限
• 确保GitLab的git用户对该脚本拥有执行权限

优化建议 #

• 批量查询优化：收集所有待验证的工单ID，一次性调用API批量查询，减少请求次数
• 状态缓存：对近期查询过的工单状态进行本地缓存，避免重复API调用
• 分支针对性验证：可添加逻辑仅对主分支（如main、develop）启用验证，其他分支跳过
• 错误提示细化：根据不同错误场景返回更具体的提示，帮助开发者快速修正

内容的提问来源于stack exchange，提问作者Vandana