gh workflow run
gh workflow run [<workflow-id> | <workflow-name>] [flags]
为给定工作流程创建一个 workflow_dispatch 事件。
此命令将触发 GitHub Actions 运行给定工作流程文件。给定工作流程文件必须支持 on.workflow_dispatch 触发器才能以这种方式运行。
如果工作流程文件支持输入，则可以通过几种方式指定它们
- 交互式
- 通过
-f/--raw-field或-F/--field标志 - 作为 JSON，通过标准输入
选项
-F,--field <key=value>- 以 key=value 格式添加字符串参数，尊重 @ 语法（参见“gh help api”）。
-
--json - 通过 STDIN 以 JSON 格式读取工作流程输入
-f,--raw-field <key=value>- 以 key=value 格式添加字符串参数
-r,--ref <string>- 包含要运行的工作流程文件版本的树枝或标记名称
从父命令继承的选项
-R,--repo <[HOST/]OWNER/REPO>- 使用 [HOST/]OWNER/REPO 格式选择另一个存储库
示例
# Have gh prompt you for what workflow you'd like to run and interactively collect inputs
$ gh workflow run
# Run the workflow file 'triage.yml' at the remote's default branch
$ gh workflow run triage.yml
# Run the workflow file 'triage.yml' at a specified ref
$ gh workflow run triage.yml --ref my-branch
# Run the workflow file 'triage.yml' with command line inputs
$ gh workflow run triage.yml -f name=scully -f greeting=hello
# Run the workflow file 'triage.yml' with JSON via standard input
$ echo '{"name":"scully", "greeting":"hello"}' | gh workflow run triage.yml --json