介绍
本教程将演示如何在应用特定标签时使用 GitHub CLI 来添加有关问题的注释。 例如,当 help wanted
标签添加到问题中后,可以添加注释来建议参与者处理该问题。 有关 GitHub CLI 的详细信息,请参阅“在工作流中使用 GitHub CLI”。
在本教程中,你将首先创建一个使用 gh issue comment
命令添加问题注释的工作流文件。 然后,您将自定义工作流以适应您的需要。
创建工作流程
-
选择要应用此项目管理工作流程的仓库。 您可以使用您有写入权限的现有仓库,或者创建一个新的仓库。 有关创建存储库的详细信息,请参阅“创建新仓库”。
-
在存储库中,创建一个名为
.github/workflows/YOUR_WORKFLOW.yml
的文件,将YOUR_WORKFLOW
替换为你选择的名称。 这是一个工作流程文件。 有关在 GitHub 上创建新文件的详细信息,请参阅“创建新文件”。 -
将以下 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:
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:
-
自定义工工作流程文件中的参数:
- 将
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 的详细信息,请参阅“基本撰写和格式语法”。
- 将
-
将工作流程文件提交到仓库的默认分支。 有关详细信息,请参阅“创建新文件”。
测试工作流程
每当仓库中的问题被标记时,此工作流就会运行。 如果添加的标签是工作流文件中指定的标签之一,gh issue comment
命令将添加你为该问题指定的注释。
通过将指定的标签应用于议题来测试工作流程。
- 在仓库中打开一个议题。 有关详细信息,请参阅“创建议题”。
- 使用工作流程文件中的指定标签标记议题。 有关详细信息,请参阅“管理标签”。
- 要查看通过标记议题所触发的工作流程运行,请查看工作流程运行的历史记录。 有关详细信息,请参阅“查看工作流程运行历史记录”。
- 当工作流程完成时,您标记的议题应已添加评论。
后续步骤
- 要详细了解可以使用 GitHub CLI 执行的其他操作,例如编辑现有的注释,请访问 GitHub CLI 手册。