Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

添加标签时评论议题

您可以使用 GitHub Actions 在应用特定标签时自动评论议题。

简介

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

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

创建工作流程

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

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

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

    YAML
    # <a name="this-workflow-uses-actions-that-are-not-certified-by-github"></a>此工作流使用未经 GitHub 认证的操作。
    # <a name="they-are-provided-by-a-third-party-and-are-governed-by"></a>它们由第三方提供,并受
    # <a name="separate-terms-of-service-privacy-policy-and-support"></a>单独的服务条款、隐私政策和支持
    # <a name="documentation"></a>文档。
    
    # <a name="github-recommends-pinning-actions-to-a-commit-sha"></a>GitHub 建议将操作固定到提交 SHA。
    # <a name="to-get-a-newer-version-you-will-need-to-update-the-sha"></a>若要获取较新版本,需要更新 SHA。
    # <a name="you-can-also-reference-a-tag-or-branch-but-the-action-may-change-without-warning"></a>还可以引用标记或分支,但该操作可能会更改而不发出警告。
    
    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@a35cf36e5301d70b76f316e867e7788a55a31dae
            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:
  4. 自定义工工作流程文件中的参数:

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

测试工作流程

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

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

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

后续步骤