Skip to main content

手动运行工作流程

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

配置工作流程手动运行

要手动运行工作流程,工作流程必须配置为在发生 workflow_dispatch 事件时运行。 要触发 Workflow_spoch 事件,您的工作流程必须在默认分支中。 有关配置 workflow_paid 事件的更多信息,请参阅“触发工作流程的事件”。

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

运行工作流程

  1. 在 GitHub.com 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡
  3. 在左侧边栏中,单击您想要运行的工作流程。 操作选择工作流程
  4. 在工作流程运行列表上方选择 Run workflow(运行工作流程)操作工作流程调度
  5. 使用 Branch(分支)下拉菜单选择工作流程的分支,并键入输入参数。 单击 Run workflow(运行工作流程)操作手动运行工作流程

要了解有关 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-name

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

gh run watch

使用 REST API 运行工作流程

使用 REST API 时,应将 inputsref 配置为请求正文参数。 如果忽略输入,则使用工作流程文件中定义的默认值。

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

有关使用 REST API 的更多信息,请参阅“创建工作流调度事件”。