diff --git a/runner-docs/reference/cli.md b/runner-docs/reference/cli.md index 553196b9..ae2e0be4 100644 --- a/runner-docs/reference/cli.md +++ b/runner-docs/reference/cli.md @@ -103,13 +103,15 @@ Flags: --detect-event Use first event type from workflow as event that triggered the workflow -C, --directory string working directory (default ".") -n, --dryrun dryrun mode - --env stringArray env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv) + --env stringArray env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv; override env-file) --env-file string environment file to read and use as env in the containers (default ".env") -E, --event string run a event name -e, --eventpath string path to a JSON event payload file exposed as the event that triggered the workflow --gitea-instance string Gitea instance to use. -h, --help help for exec -i, --image string Docker image to use. Use "-self-hosted" to run directly on the host. (default "docker.gitea.com/runner-images:ubuntu-latest") + --input stringArray set an input the workflow declares under its workflow_dispatch or workflow_call trigger, others stay invisible to the inputs context (e.g. --input name=bar; can be specified multiple times with highest precedence) + --input-file string path to an .env-format file containing key=value pairs as baseline workflow inputs (override event inputs) --insecure-secrets NOT RECOMMENDED! Doesn't hide secrets while printing logs. -j, --job string run a specific job ID; when several workflow files define that job, also pass --workflows/-W to select the file --json Output logs in json format diff --git a/runner-docs/reference/config-example.md b/runner-docs/reference/config-example.md index 060ec25a..d88fb359 100644 --- a/runner-docs/reference/config-example.md +++ b/runner-docs/reference/config-example.md @@ -86,7 +86,7 @@ runner: # This ensures bursty output (e.g., npm install) is delivered promptly. #log_report_batch_size: 100 # The interval for reporting task state (step status, timing) to the Gitea instance. - # State is also reported immediately on step transitions (start/stop). + # State is also reported on step transitions (start/stop) and after each log flush. #state_report_interval: 5s # Per-attempt deadline for flushing the final logs and task state when a job # finishes, on a detached context so a server cancel can't block the acknowledgement. @@ -234,6 +234,8 @@ container: # A volume declared here replaces the one the runner would mount on the same container path, so the # tool cache can be kept on the host. Its source must also be allowed by valid_volumes below: # options: --volume /host/toolcache:/opt/hostedtoolcache + # With privileged disabled, options that could escape the container (--security-opt, --device, + # --cap-add, --pid, ...) are ignored in a workflow's container.options, but keep working here. #options: # The parent directory of a job's working directory. # NOTE: There is no need to add the first '/' of the path as runner will add it automatically. @@ -254,7 +256,7 @@ container: #valid_volumes: [] # Overrides the docker client host with the specified one. # If it's empty, runner will find an available docker host automatically. - # If it's "-", runner will find an available docker host automatically, but the docker host won't be mounted to the job containers and service containers. + # If it's "-", runner will find an available docker host automatically, but won't mount it into the job and action containers. # If it's not empty or "-", the specified docker host will be used. An error will be returned if it doesn't work. #docker_host: "" # Pull docker image(s) even if already present. diff --git a/runner-docs_versioned_docs/version-3/reference/config-example.md b/runner-docs_versioned_docs/version-3/reference/config-example.md index 060ec25a..d88fb359 100644 --- a/runner-docs_versioned_docs/version-3/reference/config-example.md +++ b/runner-docs_versioned_docs/version-3/reference/config-example.md @@ -86,7 +86,7 @@ runner: # This ensures bursty output (e.g., npm install) is delivered promptly. #log_report_batch_size: 100 # The interval for reporting task state (step status, timing) to the Gitea instance. - # State is also reported immediately on step transitions (start/stop). + # State is also reported on step transitions (start/stop) and after each log flush. #state_report_interval: 5s # Per-attempt deadline for flushing the final logs and task state when a job # finishes, on a detached context so a server cancel can't block the acknowledgement. @@ -234,6 +234,8 @@ container: # A volume declared here replaces the one the runner would mount on the same container path, so the # tool cache can be kept on the host. Its source must also be allowed by valid_volumes below: # options: --volume /host/toolcache:/opt/hostedtoolcache + # With privileged disabled, options that could escape the container (--security-opt, --device, + # --cap-add, --pid, ...) are ignored in a workflow's container.options, but keep working here. #options: # The parent directory of a job's working directory. # NOTE: There is no need to add the first '/' of the path as runner will add it automatically. @@ -254,7 +256,7 @@ container: #valid_volumes: [] # Overrides the docker client host with the specified one. # If it's empty, runner will find an available docker host automatically. - # If it's "-", runner will find an available docker host automatically, but the docker host won't be mounted to the job containers and service containers. + # If it's "-", runner will find an available docker host automatically, but won't mount it into the job and action containers. # If it's not empty or "-", the specified docker host will be used. An error will be returned if it doesn't work. #docker_host: "" # Pull docker image(s) even if already present.