{"meta":{"title":"手动运行工作流","intro":"将工作流配置为在workflow_dispatch事件上运行时，可以使用“GitHubGitHub CLI操作”选项卡或 REST API 运行工作流。","product":"GitHub Actions","breadcrumbs":[{"href":"/zh/actions","title":"GitHub Actions"},{"href":"/zh/actions/how-tos","title":"操作方法"},{"href":"/zh/actions/how-tos/manage-workflow-runs","title":"管理工作流运行"},{"href":"/zh/actions/how-tos/manage-workflow-runs/manually-run-a-workflow","title":"手动运行工作流"}],"documentType":"article"},"body":"# 手动运行工作流\n\n将工作流配置为在workflow_dispatch事件上运行时，可以使用“GitHubGitHub CLI操作”选项卡或 REST API 运行工作流。\n\n## 配置工作流手动运行\n\n要手动运行工作流，必须将工作流配置为在 `workflow_dispatch` 事件上运行。\n\n要触发 `workflow_dispatch` 事件，工作流必须位于默认分支中。 有关配置 `workflow_dispatch` 事件的详细信息，请参阅 [触发工作流的事件](/zh/actions/reference/workflows-and-actions/events-that-trigger-workflows#workflow_dispatch)。\n\n执行这些步骤需要对仓库的写入访问权限。\n\n## 运行工作流\n\n\n\n\n\n> \\[!NOTE]\n> 若要详细了解 GitHub CLI，请参阅“[关于 GitHub CLI](/zh/github-cli/github-cli/about-github-cli)”。\n\n要运行工作流，请使用 `workflow run` 子命令。 将 `workflow` 参数替换为要运行的工作流的名称、ID 或文件名。 例如，`\"Link Checker\"`、`1234567` 或 `\"link-check-test.yml\"`。 如果未指定工作流， GitHub CLI 则返回交互式菜单供你选择工作流。\n\n```shell\ngh workflow run WORKFLOW\n```\n\n如果工作流接受输入， GitHub CLI 将提示输入输入。 或者，可以使用 `-f` 或 `-F` 添加 `key=value` 格式的输入。 使用 `-F` 从文件中读取。\n\n```shell\ngh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt\n```\n\n你也可以使用标准输入以 JSON 的身份传递输入。\n\n```shell\necho '{\"name\":\"mona\", \"greeting\":\"hello\"}' | gh workflow run greet.yml --json\n```\n\n要在存储库的默认分支以外的分支上运行工作流，请使用 `--ref` 标记。\n\n```shell\ngh workflow run WORKFLOW --ref BRANCH\n```\n\n要查看工作流运行的进度，请使用 `run watch` 子命令，并从交互式列表中选择运行。\n\n```shell\ngh run watch\n```\n\n
\n\n## 使用 REST API 运行工作流\n\n使用 REST API 时，应将 `inputs` 和 `ref` 配置为请求正文参数。 如果忽略输入，则使用工作流文件中定义的默认值。\n\n> \\[!NOTE]\n> 最多可以为事件定义 25 `inputs`。`workflow_dispatch`\n\n有关使用 REST API 的详细信息，请参阅 [工作流的 REST API 终结点](/zh/rest/actions/workflows#create-a-workflow-dispatch-event)。"}