如何在GitLab合并请求成功合并后添加备注？

下面提供两种简单可行的实现方式，优先推荐CI/CD方案，无需额外搭建外部服务：

方案一：GitLab CI/CD + GitLab API #

这是最直接的方案，利用GitLab内置的CI/CD流水线，在合并请求成功合并后自动调用API添加备注。

步骤1：创建访问令牌 #

在GitLab项目的设置 > 访问令牌中，创建一个项目级访问令牌，勾选以下权限：

• api（用于调用合并请求备注API）
• read_repository（可选，确保流水线能正常访问项目信息）
  将令牌的值保存为CI/CD变量，比如命名为GITLAB_API_TOKEN（在设置 > CI/CD > 变量中添加，勾选"保护"和"掩码"）。

步骤2：编写CI/CD配置 #

在项目根目录的.gitlab-ci.yml中添加以下作业：

post_merge_reminder:
  stage: post_merge
  script:
    - |
      # 检查当前流水线是否来自已合并的合并请求
      if [ -z "$CI_MERGE_REQUEST_IID" ] || [ "$CI_MERGE_REQUEST_STATE" != "merged" ]; then
        echo "Not a merged merge request pipeline, exiting."
        exit 0
      fi
      # 构造API请求地址
      API_ENDPOINT="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests/${CI_MERGE_REQUEST_IID}/notes"
      # 发送POST请求添加备注
      curl --silent --request POST \
        --header "PRIVATE-TOKEN: ${GITLAB_API_TOKEN}" \
        --header "Content-Type: application/json" \
        --data '{
          "body": "请执行此链接：http://your-specific-url-here"
        }' \
        "${API_ENDPOINT}"
      echo "Reminder note added successfully."
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
      when: always
  tags:
    - docker # 根据你的运行器环境调整，比如用shell标签

说明 #

• rules条件确保作业仅在合并请求触发的流水线中运行，且合并状态为merged时执行。
• 所有CI_*开头的变量都是GitLab内置的环境变量，无需手动配置。
• 可以将固定URL替换为CI/CD变量，比如"请执行此链接：${CUSTOM_REMINDER_URL}"，然后在CI/CD变量中设置CUSTOM_REMINDER_URL的值，更灵活。

方案二：GitLab Webhook + 外部脚本 #

如果不想依赖CI/CD流水线，可以用Webhook触发外部脚本完成备注添加：

1. 在项目设置 > Webhooks中添加一个Webhook：

   • URL：填写你的外部脚本服务地址（比如自己用Python/Node.js搭建的简单接口）
   • 触发事件：勾选"Merge requests events"，并在下方勾选"Merge request merged"
   • 勾选"Enable SSL verification"（如果你的服务用HTTPS）

2. 外部脚本逻辑示例（以Python为例）：

   import requests
   import os
   from flask import Flask, request
   
   app = Flask(__name__)
   GITLAB_API_TOKEN = os.getenv("GITLAB_API_TOKEN")
   
   @app.route('/webhook', methods=['POST'])
   def handle_webhook():
       data = request.json
       # 仅处理合并成功的事件
       if data['object_attributes']['state'] != 'merged':
           return "Skipped", 200
       
       project_id = data['project']['id']
       mr_iid = data['object_attributes']['iid']
       api_url = f"https://gitlab.example.com/api/v4/projects/{project_id}/merge_requests/{mr_iid}/notes"
       
       headers = {
           "PRIVATE-TOKEN": GITLAB_API_TOKEN,
           "Content-Type": "application/json"
       }
       payload = {
           "body": "请执行此链接：http://your-specific-url-here"
       }
       requests.post(api_url, json=payload, headers=headers)
       return "Note added", 200
   
   if __name__ == '__main__':
       app.run(host='0.0.0.0', port=5000)
   

注意事项 #

• 确保外部服务能被GitLab访问到（公网地址或内网打通）。
• 同样需要准备GitLab访问令牌，作为环境变量注入到外部脚本中。

额外优化 #

如果担心重复添加备注，可以在脚本中先调用API获取该合并请求的已有备注，检查是否存在相同内容后再决定是否发送POST请求：

# 检查是否已存在相同备注
EXISTING_NOTES=$(curl --silent --header "PRIVATE-TOKEN: ${GITLAB_API_TOKEN}" "${API_ENDPOINT}")
if echo "${EXISTING_NOTES}" | grep -q "请执行此链接：http://your-specific-url-here"; then
  echo "Reminder note already exists, skipping."
  exit 0
fi

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