onsdigital/github-pr-label-checker

镜像概述

本Docker镜像是基于https://github.com/agilepathway/label-checker%E9%A1%B9%E7%9B%AE%E7%9A%84%E7%89%88%E6%9C%AC%EF%BC%8C%E4%B8%93%E9%97%A8%E8%AE%BE%E8%AE%A1%E4%B8%BAGitHub Action组件，用于在GitHub仓库中自动化强制拉取请求(Pull Request)必须包含预设的必填标签，从而规范代码提交流程和项目管理。

核心功能与特性

• 强制必填标签验证：检查拉取请求是否包含所有指定的必填标签，未满足时阻止PR合并或触发提醒
• 灵活配置支持：可自定义设置必填标签列表，适应不同项目的标签管理需求（如"bug"、"feature"、"hotfix"等）
• GitHub生态集成：无缝对接GitHub Actions工作流，利用GitHub API获取PR信息并执行标签检查
• 轻量高效：基于Docker容器化封装，部署简单，执行速度快，不依赖复杂外部环境

使用场景与适用范围

• 团队协作规范：在多人协作的GitHub仓库中，确保所有PR都按分类标签（如功能、修复、文档等）标记，便于代码审查和版本追踪
• 自动化流程管控：作为CI/CD流程的前置检查步骤，避免无标签或标签不规范的PR进入后续构建或合并阶段
• 项目管理优化：通过标准化标签，提升PR筛选、统计和项目进度跟踪的效率，适用于各类规模的软件开发项目

使用方法与配置说明

前提条件

• 已启用GitHub Actions的GitHub仓库
• 明确项目所需的必填标签列表（如["bug", "feature", "documentation"]）

在GitHub Actions工作流中配置

1. 在仓库的.github/workflows/目录下创建或编辑工作流文件（如pr-label-check.yml）
2. 添加如下配置示例：

yaml
name: Enforce PR Labels
on:
  pull_request:
    types: [opened, edited, labeled, unlabeled, synchronize]

jobs:
  label-check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      
      - name: Enforce mandatory PR labels
        uses: docker://[镜像完整名称]  # 替换为实际Docker镜像名称（如username/label-checker:latest）
        with:
          # 逗号分隔的必填标签列表
          mandatory_labels: "bug,feature,hotfix"
          # GitHub令牌（用于访问PR信息）
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # 可选：设置检查失败时的行为（默认为"fail"）
          failure_level: "fail"

关键配置参数说明

Docker本地测试示例

如需本地验证镜像功能，可使用以下命令（需替换环境变量值）：

bash
docker run --rm \
  -e MANDATORY_LABELS="bug,feature" \
  -e GITHUB_TOKEN="your_github_personal_access_token" \
  -e PR_NUMBER="123" \
  -e GITHUB_REPOSITORY="your-username/your-repo" \
  [镜像完整名称]

注：本地测试需确保提供有效的GitHub令牌（具有repo权限）、PR编号和仓库信息。实际生产环境建议通过GitHub Actions集成使用，以获取自动环境变量注入。