简介
本教程演示了如何在工作流中使用 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
的工作流示例。