添加标签时评论议题

简介

本教程演示如何在应用特定标签时使用 peter-evans/create-or-update-comment 操作对问题添加注释。例如，当 help-wanted 标签添加到问题中后，可以添加注释来建议参与者处理该问题。

在本教程中，你将首先创建一个使用 peter-evans/create-or-update-comment 操作的工作流文件。然后，您将自定义工作流以适应您的需要。

创建工作流程

选择要应用此项目管理工作流程的仓库。您可以使用您有写入权限的现有仓库，或者创建一个新的仓库。有关创建存储库的详细信息，请参阅“创建新仓库”。
在存储库中，创建一个名为 .github/workflows/YOUR_WORKFLOW.yml 的文件，将 YOUR_WORKFLOW 替换为你选择的名称。这是一个工作流程文件。有关在 GitHub 上创建新文件的详细信息，请参阅“创建新文件”。

将以下 YAML 内容复制到工作流程文件中。

YAML

# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档。

# GitHub 建议将操作固定到提交 SHA。
# 若要获取较新版本，需要更新 SHA。
# 还可以引用标记或分支，但该操作可能会更改而不发出警告。

name: Add comment
on:
  issues:
    types:
      - labeled
jobs:
  add-comment:
    if: github.event.label.name == 'help-wanted'
    runs-on: ubuntu-latest
    permissions:
      issues: write
    steps:
      - name: Add comment
        uses: peter-evans/create-or-update-comment@5f728c3dae25f329afbe34ee4d08eef25569d79f
        with:
          issue-number: ${{ github.event.issue.number }}
          body: |
            This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:

# 此工作流使用未经 GitHub 认证的操作。
# 它们由第三方提供，并受
# 单独的服务条款、隐私政策和支持
# 文档。

# GitHub 建议将操作固定到提交 SHA。
# 若要获取较新版本，需要更新 SHA。
# 还可以引用标记或分支，但该操作可能会更改而不发出警告。

name: Add comment
on:
  issues:
    types:
      - labeled
jobs:
  add-comment:
    if: github.event.label.name == 'help-wanted'
    runs-on: ubuntu-latest
    permissions:
      issues: write
    steps:
      - name: Add comment
        uses: peter-evans/create-or-update-comment@5f728c3dae25f329afbe34ee4d08eef25569d79f
        with:
          issue-number: ${{ github.event.issue.number }}
          body: |
            This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:

自定义工工作流程文件中的参数：
- 将 if: github.event.label.name == 'help-wanted' 中的 help-wanted 替换为要处理的标签。如果想要在多个标签上操作，请使用 || 分隔条件。例如，if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' 将在 bug 或 fix me 标签添加到问题时进行注释。
- 将 body 的值更改为要添加的注释。支持 GitHub Flavored Markdown。有关 Markdown 的详细信息，请参阅“基本撰写和格式语法”。
将工作流程文件提交到仓库的默认分支。有关详细信息，请参阅“创建新文件”。

测试工作流程

每当仓库中的问题被标记时，此工作流就会运行。如果添加的标签是工作流文件中指定的标签之一，peter-evans/create-or-update-comment 操作将添加你针对问题指定的注释。

通过将指定的标签应用于议题来测试工作流程。

在仓库中打开一个议题。有关详细信息，请参阅“创建议题”。
使用工作流程文件中的指定标签标记议题。有关详细信息，请参阅“管理标签”。
要查看通过标记议题所触发的工作流程运行，请查看工作流程运行的历史记录。有关详细信息，请参阅“查看工作流程运行历史记录”。
当工作流程完成时，您标记的议题应已添加评论。

后续步骤

如需详细了解 peter-evans/create-or-update-comment 操作的其他用途（例如添加反应），请访问 peter-evans/create-or-update-comment 操作文档。

添加标签时评论议题

本文内容

简介

创建工作流程

测试工作流程

后续步骤