agilepathway/pull-request-label-checker

agilepathway/label-checker基础镜像文档

镜像概述

该镜像为 https://github.com/agilepathway/label-checker GitHub Action提供底层运行环境支持，是该Action的核心依赖组件。其主要用途是确保label-checker Action在GitHub Actions工作流环境中能够稳定、高效地执行预设功能。

核心功能和特性

• 环境依赖集成：内置label-checker Action运行所需的全部基础依赖和运行时环境，确保Action核心逻辑可直接执行
• 兼容性优化：针对GitHub Actions标准运行环境（如Ubuntu Runner）进行适配，保障跨版本兼容性
• 轻量化设计：在满足功能需求的前提下保持镜像体积精简，减少工作流执行时的拉取时间

使用场景和适用范围

该镜像专为GitHub Actions工作流场景设计，仅作为agilepathway/label-checker Action的内部依赖使用。当用户在GitHub仓库工作流中配置并使用label-checker Action时，GitHub Actions系统会自动拉取此基础镜像，无需用户手动干预或部署。

使用方法和配置说明

间接使用方式

用户无需直接操作此基础镜像，而是通过配置GitHub Actions工作流文件间接使用。以下是集成label-checker Action的典型工作流示例（该Action会自动调用本基础镜像）：

yaml
name: PR Label Validation
on:
  pull_request:
    types: [opened, synchronize, labeled, unlabeled]

jobs:
  validate-labels:
    runs-on: ubuntu-latest
    steps:
      - name: Check PR labels
        uses: agilepathway/label-checker@v1  # 自动依赖并使用本基础镜像
        with:
          # 按label-checker Action文档配置参数，例如：
          required_labels: '["enhancement", "bugfix"]'  # 必需标签列表
          forbidden_labels: '["wip"]'                  # 禁止标签列表
          repo_token: ${{ secrets.GITHUB_TOKEN }}       # GitHub API访问令牌

版本同步机制

该镜像版本与label-checker Action版本保持联动，Action会自动匹配并拉取对应版本的基础镜像，用户无需手动指定镜像版本。

注意事项

• 不建议单独使用或修改此镜像，其设计目标为仅支持label-checker Action的运行需求
• 镜像更新会随label-checker Action版本发布同步进行，确保功能一致性