开源项目 `label-when-approved-action` 使用教程

开源项目 label-when-approved-action 使用教程

label-when-approved-actionGitHub Action that labels approved pull requests项目地址:https://gitcode.com/gh_mirrors/la/label-when-approved-action

项目介绍

label-when-approved-action 是一个 GitHub Action，用于在 Pull Request 被批准时自动添加标签。这个 Action 可以帮助项目维护者自动化管理 Pull Request 的流程，减少手动操作，提高效率。

项目快速启动

要使用 label-when-approved-action，你需要在你的 GitHub 仓库中创建一个 .github/workflows 目录，并在其中添加一个 YAML 文件，例如 label-when-approved.yml。以下是一个示例配置：

name: Label When Approved
on:
  pull_request:
    types: [closed]

jobs:
  label:
    runs-on: ubuntu-latest
    steps:
      - name: Label when approved
        uses: abinoda/label-when-approved-action@v1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          label: 'approved'

在这个配置中：

• on: pull_request: types: [closed] 表示当 Pull Request 关闭时触发这个 Action。
• uses: abinoda/label-when-approved-action@v1 指定了使用的 Action 版本。
• with: repo-token: ${{ secrets.GITHUB_TOKEN }} 提供了 GitHub 的访问令牌。
• label: 'approved' 指定了要添加的标签名称。

应用案例和最佳实践

应用案例

假设你是一个开源项目的维护者，你希望在 Pull Request 被批准并合并后自动添加一个 approved 标签，以便更好地跟踪和管理这些 Pull Request。使用 label-when-approved-action 可以轻松实现这一需求。

最佳实践

1. 配置多个标签：你可以根据不同的审批状态配置多个标签，例如 approved、needs-review 等。
2. 结合其他 Action：可以将 label-when-approved-action 与其他 GitHub Action 结合使用，例如在添加标签后自动通知相关人员或进行其他自动化操作。

典型生态项目

label-when-approved-action 可以与以下典型生态项目结合使用：

1. GitHub Actions：作为 GitHub Actions 生态系统的一部分，可以与其他 Action 协同工作，实现更复杂的自动化流程。
2. Pull Request 管理工具：可以与各种 Pull Request 管理工具结合，提高项目管理的效率和质量。

通过以上配置和使用方法，你可以轻松地将 label-when-approved-action 集成到你的 GitHub 项目中，实现 Pull Request 管理的自动化。

label-when-approved-actionGitHub Action that labels approved pull requests项目地址:https://gitcode.com/gh_mirrors/la/label-when-approved-action