decathlon/pull-request-labeler-action

decathlon/pull-request-labeler-action 镜像说明

镜像概述

decathlon/pull-request-labeler-action是一款GitHub Action镜像，旨在通过提交文件的类型自动为拉取请求（PR）添加标签，减少手动标签操作的繁琐，帮助团队高效管理代码审查流程。

核心功能

1. 自动标签匹配：基于提交文件的正则表达式规则，自动为PR添加对应标签；
2. 灵活配置：支持自定义正则表达式与标签的映射关系，适配不同项目需求；
3. 自动创建标签：若配置的标签在仓库中不存在，镜像会自动创建该标签。

使用场景

• 代码仓库中PR的自动化分类管理（如区分TypeScript文件、文档文件、依赖配置文件等）；
• 团队协作中快速识别PR涉及的模块或修改类型，提升审查效率。

配置说明

1. 创建标签规则配置文件

在项目根目录下创建.github/label-pr.yml，示例配置如下：

yaml
- regExp: ".*\\.ts+$"
  labels: ["typescript"]
- regExp: ".*\\.sql+$"
  labels: ["database", "critical"]
- regExp: ".*\\.md+$"
  labels: ["documentation"]
- regExp: "^(pom\\.xml|package\\.json|build\\.gradle)$"
  labels: ["dependencies"]
- regExp: ".*\\.(zip|jar|war|ear)+$"
  labels: ["artifact", "invalid"]

2. 配置GitHub Action工作流

在项目根目录下创建.github/workflows/labeler.yml，示例配置如下：

yaml
# 自动关联标签的工作流
name: labeler
# 触发事件：拉取请求
on: [pull_request]
jobs:
  label:
    runs-on: ubuntu-18.04
    steps:
      # 检出仓库以访问配置文件
      - uses: actions/checkout@v1
        with:
          fetch-depth: 1
      - name: Labeler
        uses: docker://decathlon/pull-request-labeler-action:2.0.0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          # 可覆盖配置文件路径，默认路径为.github/label-pr.yml
          CONFIG_PATH: ${{ secrets.GITHUB_WORKSPACE }}/.github/label-pr.yml

注意：v1.x.x版本已废弃，建议使用v2.0.0及以上版本以兼容GitHub Action的YAML语法。