cilium/github-actions

cilium-actions 技术文档

概述和主要用途

cilium-actions是一个包含GitHub Actions逻辑的仓库，用于在github.com/cilium/cilium项目中执行自动化维护任务。它通过配置文件实现PR的全流程自动化管理，包括项目看板列分配、标签管理、提交消息验证、PR合并控制及测试flake跟踪等功能，旨在提升Cilium项目的维护效率和规范性。

核心功能和特性

• 项目自动管理：自动将打开或重新打开的PR添加到指定GitHub项目的指定列
• 标签驱动的项目移动：基于PR标签（如needs-backport/1.6）将PR动态移动到不同项目列，支持多版本并行管理
• 提交消息验证：强制检查PR中所有提交是否包含指定字符串（如DCO签名），未满足时自动添加提示评论和阻止标签
• PR合并阻止机制：通过检查标签状态（如发布说明标签是否设置、是否存在dont-merge/*标签）阻止不合规PR合并
• 自动标签功能：PR打开或重新打开时自动添加预设标签（如kind/backports）
• 测试Flake跟踪：监控Jenkins测试作业，智能识别和跟踪测试flake，支持配置稳定作业基线、相似度阈值及忽略特定失败类型

使用场景和适用范围

适用于Cilium项目的维护者和开发者，主要应用于：

• 自动化管理PR在GitHub项目看板中的生命周期
• 确保提交符合项目贡献规范（如DCO签名要求）
• 标准化PR标签使用，确保发布说明等关键标签的正确设置
• 监控和管理CI测试中的flake问题，提高测试稳定性和可靠性

详细使用方法和配置说明

配置文件位置

配置文件需放置在项目根目录下的.github/maintainers-little-helper.yml路径。

配置选项详解

1. 项目自动管理

自动将所有打开或重新打开的PR添加到指定GitHub项目的指定列：

yaml
# 将PR自动添加到指定项目列
project: "https://github.com/cilium/cilium/projects/80"
column: "In progress"

2. 标签驱动的项目移动

根据PR标签将其移动到对应项目列，同一分支若设置多个冲突标签则不执行操作：

yaml
move-to-projects-for-labels-xored:
  v1.6:  # 版本标识
    needs-backport/1.6:  # 触发标签
      project: "https://github.com/cilium/cilium/projects/1"  # 目标项目URL
      column: "Needs backport from master"  # 目标列名称
    backport-pending/1.6:
      project: "https://github.com/cilium/cilium/projects/1"
      column: "Backport pending to v1.6"
    backport-done/1.6:
      project: "https://github.com/cilium/cilium/projects/1"
      column: "Backport done to v1.6"
  v1.5:  # 支持多版本配置
    needs-backport/1.5:
      project: "https://github.com/cilium/cilium/projects/2"
      column: "Needs backport from master"
    # ... 其他标签配置

3. 提交消息要求

检查PR中所有提交是否包含指定消息，未满足时添加提示评论和标签：

yaml
require-msgs-in-commit:
  - msg: "Signed-off-by"  # 需包含的字符串（或使用regexpMsg指定正则表达式）
    helper: "https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin"  # 提示评论链接
    set-labels:  # 未满足时自动添加的标签
      - "dont-merge/needs-sign-off"

4. PR合并阻止

通过检查标签状态阻止不符合条件的PR合并：

yaml
block-pr-with:
  labels-unset:  # 检查未设置的必要标签
    - regex-label: "release-note/.*"  # 需匹配的标签正则表达式
      helper: "Release note label not set, please set the appropriate release note."  # 提示评论
      set-labels:  # 未满足时添加的标签
        - "dont-merge/needs-release-note"
  labels-set:  # 检查已设置的阻塞标签
    - regex-label: "dont-merge/.*"  # 需阻止的标签正则表达式
      helper: "Blocking mergeability of PR as 'dont-merge/.*' labels are set"  # 合并检查提示信息

5. 自动标签

PR打开或重新打开时自动添加指定标签：

yaml
auto-label:
  - "kind/backports"
  - "backport/1.6"

6. Flake跟踪配置

监控和管理测试flake的详细规则配置：

yaml
flake-tracker:
  issue-tracker-config:
    issue-labels:  # 用于搜索或创建flake issue的标签
    - project/ci-force
  jenkins-config:
    jenkins-url: https://jenkins.cilium.io  # Jenkins服务URL
    regex-trigger: (^test-me-please)  # 用于识别触发评论的正则表达式
    stable-jobs:  # 稳定作业列表（作为flake对比基线）
    - cilium-master-gke
    - cilium-master-k8s-1.16-kernel-net-next
    - cilium-master-k8s-1.17-kernel-4.9
    # ... 其他稳定作业
    pr-jobs:  # PR作业与稳定作业的关联配置
      Cilium-PR-K8s-1.16-net-next:
        correlate-with-stable-jobs:
        - cilium-master-k8s-1.16-kernel-net-next
      # ... 其他PR作业配置
  max-flakes-per-test: 5  # 单次测试最大flake数，超过则不视为flake
  flake-similarity: 0.75  # 测试失败相似度阈值（0-1，值越高表示要求越相似）
  ignore-failures:  # 始终忽略的失败消息
  - failed due to BeforeAll failure
  - Cilium cannot be installed
  - cilium pre-flight checks failed