trivago/rumi

rumi

rumi是一个基于容器的作业执行平台，它读取并执行项目中.rumi.yml文件定义的作业，目标是提升作业执行的灵活性，并将项目配置的责任交给维护者。

核心功能

1. 阶段化作业执行：CI作业按阶段分组，阶段顺序执行，同一阶段内的作业并行运行；某个作业失败则终止整个构建。
2. 灵活的作业配置：支持docker-compose语法定义容器环境，可指定命令、入口点、自定义CI容器及超时时间。
3. 环境变量注入：运行时自动注入GIT_COMMIT、GIT_BRANCH、GIT_URL等环境变量到测试容器。
4. 本地执行支持：提供脚本可在本地下载安装rumi，方便项目本地测试作业。

使用场景

• 项目CI/CD流程：用于自动化执行构建、测试、部署等阶段的作业。
• 本地作业验证：开发者可在本地运行.rumi.yml定义的作业，提前验证配置正确性。

配置说明

语法结构

阶段（Stages）

作业按阶段分组，示例：

yaml
stages:
  Initialisation:
    Install npm dependencies:
      ...
    Install composer dependencies:
      ...
  Tests:
    Unit tests:
      ...
    Integration tests:
      ...
    CSS lint:
      ...

同一阶段内的作业并行执行，所有阶段按顺序完成。

作业（Jobs）

每个作业的配置项：

yaml
Job name:
  docker: // 必需，docker-compose语法（定义或文件路径）
  commands: // 可选，容器内执行的命令列表
    - command one
    - command two
  entrypoint: sh // 可选，容器入口点
  ci_image: name_of_the_container // 可选，指定自定义CI容器（默认第一个容器）
  timeout: 100 // 可选，超时时间（秒，默认1200）

作业失败条件：ci_image容器返回状态非0。

可用环境变量

• GIT_COMMIT：当前提交的SHA值
• GIT_BRANCH：当前分支名称
• GIT_URL：代码检出的URL

限制

1. 端口配置会被忽略，CI作业无法暴露端口；若需容器间通信，需使用Docker链接。
2. 不支持docker-compose的build标志，需预先构建镜像并推送到registry，使用image标志引用。

本地执行示例

安装rumi

• Linux/macOS：

bash
wget https://raw.githubusercontent.com/trivago/rumi/master/rumi
mv rumi /usr/local/bin/rumi
chmod +x /usr/local/bin/rumi

• Windows：下载https://raw.githubusercontent.com/trivago/rumi/master/rumi.bat%E5%B9%B6%E6%B7%BB%E5%8A%A0%E5%88%B0%E7%B3%BB%E7%BB%9FPATH%E3%80%82

运行作业

在项目目录（含.rumi.yml文件）执行：

bash
rumi