tiangolo/label-approved

Label Approved

镜像概述和主要用途

Label Approved 是一个GitHub Action，用于为已获得指定数量批准的Pull Requests（PR）自动添加标签。该工具灵感来源于https://github.com/abinoda/label-when-approved-action%EF%BC%8C%E4%BD%86%E5%A2%9E%E5%8A%A0%E4%BA%86%E5%AF%B9%E6%9D%A5%E8%87%AAfork%E7%9A%84PR%E7%9A%84%E6%94%AF%E6%8C%81%E3%80%82%E9%80%9A%E8%BF%87%E9%85%8D%E7%BD%AE%E4%B8%8D%E5%90%8C%E6%A0%87%E7%AD%BE%E7%9A%84%E6%89%B9%E5%87%86%E6%95%B0%E9%87%8F%E5%92%8C%E8%BF%87%E6%BB%A4%E6%9D%A1%E4%BB%B6%EF%BC%8C%E5%8F%AF%E8%87%AA%E5%8A%A8%E5%8C%96%E7%AE%A1%E7%90%86PR%E7%9A%84%E6%A0%87%E7%AD%BE%E7%8A%B6%E6%80%81%EF%BC%8C%E6%8F%90%E5%8D%87%E5%9B%A2%E9%98%9F%E5%8D%8F%E4%BD%9C%E6%95%88%E7%8E%87%E3%80%82

核心功能和特性

• 标签自动添加：根据PR获得的批准数量自动添加对应标签
• 灵活配置：支持为不同标签设置不同的最小批准数量和过滤标签
• fork PR支持：兼容处理来自fork仓库的PR
• 过滤机制：可通过await_label指定需要检查的PR标签，仅处理符合条件的PR
• 多标签管理：支持同时配置多个标签规则，满足不同场景需求

使用场景和适用范围

适用于需要自动化管理PR标签状态的GitHub仓库，特别是：

• 团队协作中需要根据批准数量明确PR状态（如"approved-2"表示已获得2个批准）
• 需要自动移除"待审核"类标签并添加"已批准"类标签的场景
• 管理来自fork的PR，确保批准状态正确识别和标签更新

使用方法和配置说明

安装步骤

在GitHub仓库中创建.github/workflows/label-approved.yml文件，配置工作流即可使用。

基本使用示例

以下是最小配置示例，使用默认参数：

yaml
name: Label Approved

on:
  schedule:
    - cron: "0 0 * * *"  # 每天运行一次

jobs:
  label-approved:
    runs-on: ubuntu-latest
    steps:
      - uses: docker://tiangolo/label-approved:0.0.2  # 使用Docker镜像
        with:
          token: ${{ secrets.GITHUB_TOKEN }}  # 需提供GitHub Token

默认配置下，该工作流会每天检查所有开放PR：

• 对带有awaiting review标签的PR检查批准数量
• 若获得2个或更多批准，会移除awaiting review标签并添加approved-2标签

高级配置示例

可通过config参数自定义标签规则，配置为JSON对象字符串。以下示例配置3个标签规则：

yaml
name: Label Approved

on:
  schedule:
    - cron: "0 0 * * *"

jobs:
  label-approved:
    runs-on: ubuntu-latest
    steps:
      - uses: docker://tiangolo/label-approved:0.0.2
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          config: >  # 多行字符串格式
            {
              "approved-1":
                {
                  "number": 1,
                  "await_label": "awaiting review"
                },
              "omg 2 approved":
                {
                  "number": 2,
                  "await_label": "only 2"
                },
              "approvals in 3D":
                {
                  "number": 3
                }
            }

配置参数说明

config配置详解

config是一个JSON对象，键为标签名称，值为该标签的配置对象，包含：

• number：必需，最小批准数量（整数）
• await_label：可选，过滤PR的标签名称。若指定，仅处理带有该标签的PR；若省略或为null，处理所有开放PR

配置效果说明

上述高级配置示例的效果：

• approved-1：为带有awaiting review标签且获得1个及以上批准的PR添加该标签，并移除awaiting review标签
• omg 2 approved：为带有only 2标签且获得2个及以上批准的PR添加该标签，并移除only 2标签
• approvals in 3D：为获得3个及以上批准的所有开放PR添加该标签（无await_label过滤）

发布说明

0.0.2

• 🐛 修复批准用户计数逻辑（PR https://github.com/tiangolo/label-approved/pull/6%EF%BC%89
• 🐛 修复Docker中Python应用名称调用问题（PR https://github.com/tiangolo/label-approved/pull/5%EF%BC%89
• ⬆️ 升级GitHub Action Latest Changes（PR https://github.com/tiangolo/label-approved/pull/4%EF%BC%89
• 🐛 修复批准数量计算逻辑，仅统计每个用户的最新批准（PR https://github.com/tiangolo/label-approved/pull/3%EF%BC%89

0.0.1

• 初始版本发布 🎉

许可证

本项目采用MIT许可证。