Skip to main content

手动运行工作流程

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

配置工作流程手动运行

要手动运行工作流,必须将工作流配置为在 workflow_dispatch 事件上运行。 要触发 workflow_dispatch 事件,工作流必须位于默认分支中。 有关配置 workflow_dispatch 事件的详细信息,请参阅“触发工作流的事件”。

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

运行工作流程

  1. 在 your enterprise 上,导航到存储库的主页。 1. 在你的存储库名称下,单击 “操作”。 主存储库导航中的“操作”选项卡
  2. 在左侧边栏中,单击您想要运行的工作流程。 操作选择工作流
  3. 在工作流运行列表上方,选择“运行工作流”。 操作工作流调度
  4. 使用“分支”下拉菜单,选择工作流的分支,并键入输入参数。 单击“运行工作流”。 操作手动运行工作流

若要详细了解 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 的详细信息,请参阅“创建工作流调度事件”。