添加标签时评论议题

简介

本教程演示如何使用 peter-evans/create-or update- 操作在应用特定标签时评论议题。 例如，当 help-wanted 标签添加到议题中后，您可以添加评论来鼓励贡献者处理该议题。

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

创建工作流程

1. 选择要应用此项目管理工作流程的仓库。 您可以使用您有写入权限的现有仓库，或者创建一个新的仓库。 关于创建仓库的更多信息，请参阅“创建新仓库”。

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

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

   YAML

   # 此工作流使用未经 GitHub 认证的操作。
   # 它们由第三方提供，并受
   # 单独的服务条款、隐私政策和支持
   # 文档管理。
   
   name: Add comment
   on:
     issues:
       types:
         - labeled
   jobs:
     add-comment:
       if: github.event.label.name == 'help-wanted'
       runs-on: ubuntu-latest
       steps:
         - name: Add comment
           uses: peter-evans/create-or-update-comment@a35cf36e5301d70b76f316e867e7788a55a31dae
           with:
             issue-number: ${{ github.event.issue.number }}
             body: |
               This issue is available for anyone to work on. **请确保在您的拉请求中引用此议题。** :sparkles: 谢谢您的贡献！ :sparkles:

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

   • 将 if: github.event.label.name == 'help-wanted' 中的 help-wanted 替换为您想要操作的标签。 如果您想要操作多个标签，请用 || 分隔条件。 例如，只要 bug 或 fix me 标签添加到议题，if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' 就会评论。
   • 将 body 的值更改为您想要添加的评论。 支持 GitHub Flavored Markdown。 有关 Markdown 的更多信息，请参阅“基本撰写和格式语法”。

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

测试工作流程

每当仓库中的问题被标记时，此工作流就会运行。 如果添加的标签是您在工作流程文件中指定的标签之一，peter-evans/create-or update-comment 操作将添加您指定的评论到此议题。

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

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

后续步骤

• 要详细了解您可以使用 peter-evans/create-or-update-comment 操作执行的其他事项，如添加反应，请访问 peter-evans/create-or-update-comment 操作文档。