rogierslag/consuela

Consuela

!consuela

镜像概述

Consuela是inventid团队使用的工具，旨在防止代码仓库中的意外合并操作。它通过检查Pull Request（PR）的标签来阻止合并，并支持通过特定端点锁定整个仓库。

核心功能

1. PR标签检查：若PR包含指定标签，Consuela会向PR添加状态以阻止合并。
2. 仓库锁定：通过/merge-lock端点实现仓库全局锁定：
   • 使用POST请求设置锁定，支持可选的message参数说明锁定原因；
   • 使用DELETE请求释放锁定；
   • 注意：锁定状态存储在全局变量中，若Consuela重启，开放PR的锁定状态不会自动更新。

使用场景

• 团队协作时，防止未完成或未审核的PR被意外合并；
• 发布前或系统维护期间，锁定仓库以避免不必要的合并操作。

配置说明

1. 将default.json.example复制为default.json；
2. 编辑配置文件中的用户名和密码（该用户需拥有仓库写权限）；
3. 添加目标仓库；
4. 添加需要阻止合并的标签名称；
5. 配置Webhook：将Webhook指向Consuela运行的URL，内容类型选择application/json，Secret留空，仅勾选Pull Request事件；
6. 启动系统。

部署示例

直接使用Node.js运行

bash
node server.js

Puppet配置

puppet
class consuela {

  file { '/opt/consuela.json':
    ensure => present,
    source => 'puppet:///modules/consuela/config.json',
    mode   => '0600',
    notify => Docker::Run['consuela']
  }

  docker::image { 'rogierslag/consuela:latest': }

  docker::run { 'consuela':
    image => 'rogierslag/consuela',
    volumes => ['/opt/consuela.json:/opt/consuela/config/default.json'],
    ports => ["${ipaddress_eth0}:8543:8543"]
  }

  firewall { '200 allow gonzuela':
    dport => ['8543'],
    proto => 'tcp',
    action => 'accept'
  }
}

Docker运行

bash
sudo docker run -d -v /opt/consuela.json:/opt/consuela/config/default.json -p <IP>:8543:8543 rogierslag/consuela