添加标签时对问题发表评论

简介

本教程演示如何使用 GitHub CLI 在应用特定标签时对问题发表评论。例如，当将 `help wanted` 标签添加到问题时，您可以添加评论以鼓励贡献者处理该问题。有关 GitHub CLI 的更多信息，请参阅“在工作流中使用 GitHub CLI”。

在本教程中，您将首先创建一个使用 `gh issue comment` 命令对问题发表评论的工作流文件。然后，您可以根据需要自定义工作流。

创建工作流

1. 选择您要在其中应用此项目管理工作流的存储库。您可以使用您拥有写入权限的现有存储库，也可以创建一个新的存储库。有关创建存储库的更多信息，请参阅“创建新的存储库”。

2. 在您的存储库中，创建一个名为 `.github/workflows/YOUR_WORKFLOW.yml` 的文件，将 `YOUR_WORKFLOW` 替换为您选择的名称。这是一个工作流文件。有关在 GitHub 上创建新文件的更多信息，请参阅“创建新文件”。

3. 将以下 YAML 内容复制到您的工作流文件。

   YAML

   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
           run: gh issue comment "$NUMBER" --body "$BODY"
           env:
             GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GH_REPO: ${{ github.repository }}
             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:
   

4. 自定义你的工作流程文件中的参数

   • 将help wanted替换为if: github.event.label.name == 'help wanted'中你想操作的标签。如果你想操作多个标签，请用||分隔条件。例如，if: github.event.label.name == 'bug' || github.event.label.name == 'fix me'会在添加bug或fix me标签到issue时添加评论。
   • 将BODY的值更改为你想要添加的评论。支持GitHub风格的Markdown。更多关于Markdown的信息，请查看“基本写作和格式语法”。

5. 将你的工作流程文件提交到你的仓库的默认分支。更多信息，请查看“创建新文件”。

测试工作流程

每次你的仓库中的issue被添加标签时，此工作流程都会运行。如果添加的标签是你工作流程文件中指定的标签之一，gh issue comment命令会将你指定的评论添加到该issue。

通过将你指定的标签应用到一个issue来测试你的工作流程。

1. 在你的仓库中打开一个issue。更多信息，请查看“创建issue”。
2. 使用你在工作流程文件中指定的标签标记该issue。更多信息，请查看“管理标签”。
3. 要查看由标记issue触发的workflow运行，请查看你的workflow运行历史记录。更多信息，请查看“查看工作流程运行历史记录”。
4. 当工作流程完成后，你标记的issue应该会添加一条评论。

后续步骤

• 要了解有关使用GitHub CLI可以执行的其他操作（例如编辑现有评论）的更多信息，请访问GitHub CLI手册。