mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +00:00
bircni
55c3a392a1
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
2.8 KiB
2.8 KiB
sidebar_position, description
| sidebar_position | description |
|---|---|
| 4 | Dispatch a workflow |
gt workflow run
Dispatch a workflow
Synopsis
Start a run of a workflow that has a workflow_dispatch trigger.
Inputs are checked against the inputs that the workflow declares: unknown inputs, missing
required inputs and values that a choice or boolean input does not accept are refused. In a
terminal, gt asks for missing required inputs, or for every input when none is given.
The workflow is looked up among those the server lists from the default branch, so it must exist
there; --ref only selects the branch or tag whose version of it runs, as in gh. List them with
gt workflow list.
Without --ref, the workflow runs on the checked-out branch, which must be on the server, or on
the default branch when the repository does not come from the working directory.
With --follow, the command fails like gt run watch when the run completes without success.
gt workflow run <workflow> [flags]
Examples
# run a workflow on the default or current branch
$ gt workflow run CI
# run it on a branch with inputs
$ gt workflow run ci.yml --ref main -f target=production -f dry_run=false
# run it and follow the logs of its jobs
$ gt workflow run nightly --follow
Options
-f, --field key=value Workflow input as key=value (repeatable)
--follow Follow the logs of the run's jobs after dispatching it
-h, --help help for run
--interval duration Polling interval with --follow (default 2s)
-r, --ref string Branch or tag to run the workflow on (default: the current or default branch)
--timeout duration Maximum time to follow (default 30m0s)
Options inherited from parent commands
--cwd directory Working directory for repository discovery
--debug Log the method, URL, status, and duration of each HTTP request to stderr
--host URL Gitea instance URL, including any base path
--interactive Allow prompts with machine output
-q, --jq expression Filter JSON output using a jq expression; implies --json
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
--no-input Disable prompts and implicit editor/browser interactions
--remote remote Git remote used for repository discovery
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
--sudo user Perform API requests as this user (requires an administrator account)
--user name Account name on the selected instance
-y, --yes Accept confirmations without prompting
SEE ALSO
- gt workflow: View, run, enable and disable Actions workflows