手动运行工作流

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

本文内容

配置手动运行的工作流

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

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

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

运行工作流

  1. 在 GitHub 上，导航到存储库的主页。

  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或文件名。例如，“链接检查器”、“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端点”。