手动运行工作流

当工作流配置为在 workflow_dispatch 事件上运行时，您可以使用 GitHub 上的操作选项卡、GitHub CLI 或 REST API 运行工作流。

本文内容

配置工作流以手动运行

要手动运行工作流，工作流必须配置为在 workflow_dispatch 事件上运行。

要触发 workflow_dispatch 事件，您的工作流必须位于默认分支中。有关配置 workflow_dispatch 事件的更多信息，请参阅“触发工作流的事件”。

执行这些步骤需要对仓库的写入权限。

运行工作流

  1. 在 GitHub.com 上，导航到仓库的主页。

  2. 在您的仓库名称下，单击 操作.

    Screenshot of the tabs for the "github/docs" repository. The "Actions" tab is highlighted with an orange outline.

  3. 在左侧边栏中，单击要运行的工作流的名称。

    Screenshot of the "Actions" page. In the left sidebar, a workflow name is highlighted with an outline in dark orange.

  4. 在工作流运行列表上方，单击“运行工作流”按钮。

    注意：要查看运行工作流按钮，您的工作流文件必须使用workflow_dispatch事件触发器。只有使用workflow_dispatch事件触发器的工作流文件才能选择使用运行工作流按钮手动运行工作流。有关配置workflow_dispatch事件的更多信息，请参阅“触发工作流的事件”。

    Screenshot of a workflow page. Above the list of workflow runs, a button, labeled "Run workflow", is outlined in dark orange.

  5. 选择分支下拉菜单，然后单击要运行工作流的分支。

  6. 如果工作流需要输入，请填写相应字段。

  7. 单击运行工作流。

要了解有关 GitHub CLI 的更多信息，请参阅“关于 GitHub CLI”。

要运行工作流，请使用workflow run子命令。将workflow参数替换为您要运行的工作流的名称、ID 或文件名。例如，"Link Checker"、1234567 或 "link-check-test.yml"。如果您没有指定工作流，GitHub CLI 会返回一个交互式菜单供您选择工作流。

gh workflow run WORKFLOW

如果您的工作流接受输入，GitHub CLI 会提示您输入。或者，您可以使用-f 或 -F 以key=value 格式添加输入。使用-F 从文件读取。

gh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt

您也可以使用标准输入以 JSON 格式传递输入。

echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json

要在除存储库默认分支之外的分支上运行工作流，请使用--ref 标志。

gh workflow run WORKFLOW --ref BRANCH

要查看工作流运行的进度，请使用run watch 子命令，然后从交互式列表中选择运行。

gh run watch

使用 REST API 运行工作流

使用 REST API 时，您将inputs 和ref 配置为请求正文参数。如果省略输入，则使用工作流文件中定义的默认值。

注意：您可以为workflow_dispatch 事件定义最多 10 个inputs。

有关使用 REST API 的更多信息，请参阅“工作流的 REST API 端点”。