containous/lobicornis

Myrmica Lobicornis - 拉取请求（PR）自动更新与合并机器人

https://img.shields.io/github/release/containous/lobicornis.svg](https://github.com/containous/lobicornis/releases/latest) https://travis-ci.com/containous/lobicornis.svg?branch=master](https://travis-ci.com/containous/lobicornis) https://img.shields.io/docker/build/containous/lobicornis.svg](https://hub.docker.com/r/containous/lobicornis/builds/)

镜像概述

Myrmica Lobicornis是针对GitHub的自动化机器人，旨在简化PR的更新与合并流程。它通过配置规则自动处理PR的筛选、验证、更新及合并，支持多仓库管理，提升团队协作效率。

核心功能

• 筛选带有特定标签（如marker.needMerge）的开放PR；
• 管理用户或组织的所有仓库；
• 验证PR的GitHub检查（CI状态）、可合并性及所需审查数量；
• 自动更新PR（与基础分支rebase或合并）；
• 按配置方式（merge/squash/rebase/ff）合并PR；
• 关闭PR相关问题并添加相同里程碑；
• 错误时添加marker.needHumanMerge标签；
• 支持Co-authored-by信息添加到合并提交。

使用场景

适用于GitHub团队协作场景，自动化PR合并流程，确保PR符合团队规则（如CI通过、审查数量达标），减少人工操作，提升代码合并效率。

配置说明

环境变量

• GITHUB_TOKEN: GitHub访问令牌（必填）。

命令行选项

yaml
Myrmica Lobicornis:
  -config string
        配置文件路径（默认："./lobicornis.yml"）
  -h    显示帮助信息
  -server
        以Web服务器模式运行
  -version
        显示版本信息

配置文件示例

yaml
github:
  user: foo  # 组织或用户名
  token: XXXX  # GitHub令牌
  url: http://my-private-github.com  # GitHub Enterprise地址（可选）

git:
  email: bot@example.com  # Git用户邮箱
  userName: botname  # Git用户名
  ssh: false  # 是否使用SSH（默认false）

server:
  port: 80  # 服务器端口（仅server模式）

extra:
  debug: false  # 调试模式
  dryRun: true  # 模拟运行模式

markers:
  lightReview: bot/light-review  # 低审查要求标签
  mergeInProgress: status/4-merge-in-progress  # 合并中标签
  mergeMethodPrefix: bot/merge-method-  # 合并方式前缀
  needHumanMerge: bot/need-human-merge  # 需要人工合并标签
  needMerge: status/3-needs-merge  # 需要合并标签

retry:
  interval: 1m0s  # 重试间隔
  number: 1  # 最大重试次数

default:
  mergeMethod: squash  # 默认合并方式
  minReview: 1  # 最小审查数
  needMilestone: true  # 强制PR有里程碑

repositories:
  'foo/myrepo1':
    minReview: 3
  'foo/myrepo2':
    needMilestone: false

Docker部署示例

基本运行

bash
docker run -e GITHUB_TOKEN=your_token docker.xuanyuan.run/containous/lobicornis

服务器模式

bash
docker run -e GITHUB_TOKEN=your_token -p 80:80 docker.xuanyuan.run/containous/lobicornis -server

自定义配置

bash
docker run -e GITHUB_TOKEN=your_token \
  -v $(pwd)/lobicornis.yml:/app/lobicornis.yml \
  docker.xuanyuan.run/containous/lobicornis -config="/app/lobicornis.yml"

名称说明

!Myrmica Lobicornis
Myrmica Lobicornis是一种蚂蚁的学名，此处用作机器人名称，象征高效协作。