配置手动运行的工作流
要手动运行工作流,必须将工作流配置为在workflow_dispatch事件上运行。
要触发workflow_dispatch事件,您的工作流必须位于默认分支中。有关配置workflow_dispatch事件的更多信息,请参阅“触发工作流的事件”。
执行这些步骤需要对存储库的写入权限。
运行工作流
-
在 GitHub 上,导航到存储库的主页。
-
在您的存储库名称下,单击 操作.

-
在左侧边栏中,单击要运行的工作流的名称。

-
在工作流运行列表上方,单击**运行工作流**按钮。
注意
要查看**运行工作流**按钮,您的工作流文件必须使用
workflow_dispatch事件触发器。只有使用workflow_dispatch事件触发器的文件才能选择使用**运行工作流**按钮手动运行工作流。有关配置workflow_dispatch事件的更多信息,请参阅“触发工作流的事件”。
-
选择**分支**下拉菜单,然后单击要在其上运行工作流的分支。
-
如果工作流需要输入,请填写相关字段。
-
单击**运行工作流**。
要了解有关 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 端点”。