From c6b59a00bb07a617d4a81022b133ebd990733fa2 Mon Sep 17 00:00:00 2001 From: Axel Navarro Date: Fri, 16 Apr 2021 11:42:21 -0300 Subject: [PATCH] gh-workflow: add page (#5767) --- pages/common/gh-workflow.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 pages/common/gh-workflow.md diff --git a/pages/common/gh-workflow.md b/pages/common/gh-workflow.md new file mode 100644 index 0000000000..375aa0c9ed --- /dev/null +++ b/pages/common/gh-workflow.md @@ -0,0 +1,36 @@ +# gh workflow + +> List, view, and run GitHub Actions workflows. +> More information: . + +- Interactively select a workflow to view the latest jobs for: + +`gh workflow view` + +- View a specific workflow in the default browser: + +`gh workflow view {{id|workflow_name|filename.yml}} --web` + +- Display the YAML definition of a specific workflow: + +`gh workflow view {{id|workflow_name|filename.yml}} --yaml` + +- Display the YAML definition for a specific Git branch or tag: + +`gh workflow view {{id|workflow_name|filename.yml}} --ref {{branch_or_tag_name}} --yaml` + +- List workflow files (use `--all` to include disabled workflows): + +`gh workflow list` + +- Run a manual workflow with parameters: + +`gh workflow run {{id|workflow_name|filename.yml}} --raw-field {{param1}}={{value1}} --raw-field {{param2}}={{value2}}` + +- Run a manual workflow using a specific branch or tag with JSON parameters from stdin: + +`echo '{{{"param1":"value1", "param2":"value2"}}}' | gh workflow run {{id|workflow_name|filename.yml}} --ref {{branch_or_tag_name}}` + +- Enable or disable a specific workflow: + +`gh workflow {{enable|disable}} {{id|workflow_name|filename.yml}}`