hiboxsystems/marge-bot

镜像概述

该镜像是专为GitLab设计的合并机器人，旨在自动化代码合并流程。通过集成GitLab API，实现对合并请求（Merge Request）的自动检测、条件验证与执行合并，减少手动操作成本，提高开发团队协作效率。

核心功能

• 自动合并检测：定期扫描指定项目的合并请求，识别符合条件的待合并项
• 合并条件验证：支持配置多维度合并前置条件，包括：
  • CI/CD流水线状态（通过/失败）
  • 合并请求审批状态（已审批/未审批）
  • 代码冲突检测（无冲突/有冲突）
• 冲突处理机制：检测到合并冲突时，支持通过GitLab评论通知或触发Webhook告警
• 合并结果反馈：合并完成后自动更新合并请求状态，并支持通过GitLab评论、Webhook等方式推送结果

使用场景

• 开发团队自动化代码合并流程，减少人工干预
• 持续集成/持续部署（CI/CD）场景中，实现"测试通过即合并"的自动化闭环
• 多团队协作项目中，统一合并规范与执行标准
• 保护分支管理，确保只有符合条件的代码才能合并至目标分支

使用方法

前提条件

1. 已部署GitLab实例（自托管或GitLab.com）
2. 拥有GitLab个人访问令牌（Personal Access Token），需包含以下权限：
   • api：访问GitLab API
   • write_repository：修改仓库权限
   • read_api：读取合并请求信息
3. 目标GitLab项目已配置必要的分支保护规则（如CI检查、审批要求）

基础部署（Docker Run）

bash
docker run -d \
  --name gitlab-merge-bot \
  -e GITLAB_URL="https://gitlab.example.com" \  # GitLab实例URL（必填）
  -e GITLAB_API_TOKEN="glpat-xxxxxx" \          # 个人访问令牌（必填）
  -e PROJECT_ID="123" \                         # 目标项目ID（必填，可在项目设置>一般>项目ID查看）
  -e MERGE_CONDITIONS="ci_passed,approved,no_conflicts" \  # 合并条件（可选，默认：ci_passed,no_conflicts）
  -e TARGET_BRANCH="main" \                     # 目标分支（可选，默认：main）
  -e POLL_INTERVAL="30" \                       # 扫描间隔（秒，可选，默认：60）
  merge-bot:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  merge-bot:
    image: merge-bot:latest
    container_name: gitlab-merge-bot
    restart: always
    environment:
      - GITLAB_URL=https://gitlab.example.com
      - GITLAB_API_TOKEN=glpat-xxxxxx
      - PROJECT_ID=123
      - MERGE_CONDITIONS=ci_passed,approved,no_conflicts
      - TARGET_BRANCH=main
      - POLL_INTERVAL=30
      - AUTO_MERGE=true  # 是否自动执行合并（可选，默认：true）
      - CONFLICT_NOTIFY=true  # 冲突时通知（可选，默认：true）

配置参数详解

核心环境变量

高级配置（可选）

注意事项

1. 权限配置：确保GitLab API令牌具有足够权限，特别是对保护分支的合并权限
2. 合并条件兼容性：MERGE_CONDITIONS需与项目的分支保护规则匹配（如要求审批的项目需添加approved条件）
3. 冲突处理：当前版本不支持自动解决冲突，有冲突时需手动干预，可通过CONFLICT_NOTIFY参数开启通知
4. 网络连通性：容器需能访问GitLab实例（自托管实例需配置网络策略允许出站连接）