添加标签时自动为 GitHub 议题发表评论

可以使用 GitHub Actions,在议题被添加特定标签时自动发表评论。

简介

本教程演示如何使用 GitHub CLI,在议题被添加特定标签时发表评论。例如,为议题添加 help wanted 标签时,可以发布评论,鼓励贡献者参与处理。GitHub CLI 的相关用法见在工作流中使用 GitHub CLI。

首先创建一个使用 gh issue comment 命令发表评论的工作流文件,再按需求自定义该工作流。

创建工作流

  1. 选择要应用这项项目管理工作流的仓库。可以使用已有写入权限的仓库,或创建新仓库。
  2. 在仓库中创建 .github/workflows/YOUR_WORKFLOW.yml,将 YOUR_WORKFLOW 替换为选定的名称。该文件就是工作流文件。参见创建新文件。
  3. 将以下 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:
  1. 自定义工作流文件中的参数。把 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 风格的 Markdown,参见基本写作和格式语法。
  2. 将工作流文件提交到仓库的默认分支,具体操作见上述创建新文件文档。

测试工作流

每当仓库中的议题被添加标签,这个工作流都会运行。如果新添加的标签符合工作流文件指定的条件,gh issue comment 就会为该议题添加指定评论。

为议题添加指定标签来测试工作流:

  1. 在仓库中打开一个议题。
  2. 为议题添加工作流文件中指定的标签,参见管理标签。
  3. 查看工作流运行历史,找到这次添加标签触发的运行。
  4. 工作流完成后,所选议题中应该出现一条评论。

后续步骤

若要了解 GitHub CLI 还能执行哪些操作,例如编辑已有评论,请阅读 GitHub CLI 手册。

来源与许可

原文:Commenting on an issue when a label is added,GitHub Docs / GitHub, Inc.。依据官方源文件完整准备中文文本,代码保持原样。GitHub 文档采用 CC BY 4.0,许可证见 github/docs LICENSE。本文改动为中文翻译及链接绝对化。工作流未在本任务中运行。

© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享
评论 抢沙发

请登录后发表评论

    暂无评论内容