GitHub Actions Labeler 使用教程

GitHub Actions Labeler 使用教程

labeler An action for automatically labelling pull requests 项目地址: https://gitcode.com/gh_mirrors/la/labeler

1. 项目介绍

GitHub Actions Labeler 是一个用于自动标记 Pull Request 的 GitHub Action。它可以根据 Pull Request 中更改的文件路径或分支名称自动应用标签。这个工具特别适用于需要根据代码更改内容自动分类和标记 Pull Request 的项目。

2. 项目快速启动

2.1 创建配置文件

首先，在你的项目根目录下创建一个名为 .github/labeler.yml 的配置文件。这个文件定义了如何根据文件路径或分支名称来应用标签。

# .github/labeler.yml
Documentation:
  - changed-files:
    - any-glob-to-any-file: 'docs/*'

Feature:
  - head-branch: ['^feature', 'feature']

Release:
  - base-branch: 'main'

2.2 创建 GitHub Actions 工作流

接下来，创建一个 GitHub Actions 工作流文件 .github/workflows/labeler.yml，以便在 Pull Request 创建或更新时自动应用标签。

# .github/workflows/labeler.yml
name: "Pull Request Labeler"
on:
  - pull_request_target

jobs:
  labeler:
    permissions:
      contents: read
      pull-requests: write
    runs-on: ubuntu-latest
    steps:
      - uses: actions/labeler@v5
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          configuration-path: .github/labeler.yml

2.3 提交并测试

将上述配置文件和工作流文件提交到你的 GitHub 仓库中，并创建一个新的 Pull Request 来测试自动标签功能。

3. 应用案例和最佳实践

3.1 应用案例

• 文档更新：当 Pull Request 包含对 docs/ 目录下的文件进行更改时，自动应用 Documentation 标签。
• 功能开发：当 Pull Request 的分支名称以 feature 开头时，自动应用 Feature 标签。
• 发布分支：当 Pull Request 的目标分支是 main 时，自动应用 Release 标签。

3.2 最佳实践

• 精细匹配：使用 any 和 all 关键字来实现更精细的匹配规则，确保标签应用的准确性。
• 分支匹配：利用 base-branch 和 head-branch 来根据分支名称应用标签，适用于多分支开发模式。
• 路径匹配：使用 changed-files 来根据文件路径应用标签，适用于大型项目中的文件分类。

4. 典型生态项目

• GitHub Actions：GitHub Actions 是一个强大的 CI/CD 工具，Labeler 作为其中的一个 Action，可以与其他 Actions 结合使用，实现更复杂的自动化流程。
• Codeowners：Codeowners 文件可以与 Labeler 结合使用，自动分配代码审查责任人，并根据责任人自动应用标签。
• Dependabot：Dependabot 可以自动创建依赖更新的 Pull Request，Labeler 可以自动为这些 Pull Request 应用标签，方便管理和分类。

通过以上步骤和案例，你可以快速上手并充分利用 GitHub Actions Labeler 来提高项目管理的效率。

labeler An action for automatically labelling pull requests 项目地址: https://gitcode.com/gh_mirrors/la/labeler