介绍
本教程演示如何使用工作流中的 GitHub CLI 来标记新打开或重新打开的问题。 例如,每次打开或重新打开问题时,都可以添加 triage
标签。 然后,可通过筛选具有 triage
标签的问题来查看需要会审的问题。
GitHub CLI 允许你在工作流中轻松使用 GitHub API。
在本教程中,首先需要创建一个使用 GitHub CLI 的工作流文件。 然后,您将自定义工作流以适应您的需要。
创建工作流程
-
选择要应用此项目管理工作流程的仓库。 您可以使用您有写入权限的现有仓库,或者创建一个新的仓库。 有关创建存储库的详细信息,请参阅“创建新仓库”。
-
在存储库中,创建一个名为
.github/workflows/YOUR_WORKFLOW.yml
的文件,将YOUR_WORKFLOW
替换为你选择的名称。 这是一个工作流程文件。 有关在 GitHub 上创建新文件的详细信息,请参阅“创建新文件”。 -
将以下 YAML 内容复制到工作流程文件中。
YAML name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - run: gh issue edit "$NUMBER" --add-label "$LABELS" env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_REPO: ${{ github.repository }} NUMBER: ${{ github.event.issue.number }} LABELS: triage
name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - run: gh issue edit "$NUMBER" --add-label "$LABELS" env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_REPO: ${{ github.repository }} NUMBER: ${{ github.event.issue.number }} LABELS: triage
-
自定义工作流文件中的
env
值:GH_TOKEN
、GH_REPO
和NUMBER
值是使用github
和secrets
上下文自动设置的。 不需要更改这些值。- 将
LABELS
的值更改为你想要添加到此问题的标签列表。 存储库必须存在标签。 使用逗号分隔多个标签。 例如help wanted,good first issue
。 有关标签的详细信息,请参阅“管理标签”。
-
将工作流程文件提交到仓库的默认分支。 有关详细信息,请参阅“创建新文件”。
测试工作流程
每次打开或重新打开仓库中的议题时,此工作流程将添加您指定给此议题的标签。
通过在仓库中创建议题来测试工作流程。
- 在仓库中创建议题。 有关详细信息,请参阅“创建议题”。
- 要查看通过创建议题所触发的工作流程运行,请查看工作流程运行的历史记录。 有关详细信息,请参阅“查看工作流程运行历史记录”。
- 当工作流程完成时,您创建的议题应已添加指定的标签。
后续步骤
- 要详细了解使用 GitHub CLI 可以执行哪些其他操作,请参阅 GitHub CLI 手册。
- 若要详细了解可以触发工作流的不同事件,请参阅“触发工作流的事件”。
- 搜索 GitHub 以获取使用
gh issue edit
的工作流示例。