From f6e17361fe66b19b9d925f41bcbe2f88a397257c Mon Sep 17 00:00:00 2001 From: Gitea Bot Date: Mon, 2 Nov 2026 05:07:00 +0000 Subject: [PATCH] Update the runner reference pages (#628) Automated update of the generated runner reference pages from gitea/runner (main for the develop docs, the newest stable tag for every documented series), opened by the "update runner reference" scheduled workflow. Preview: https://pr-628.docs-gitea-com.pages.dev --------- Co-authored-by: Lunny Xiao Reviewed-on: https://gitea.com/gitea/docs/pulls/628 Reviewed-by: Lunny Xiao Co-authored-by: Gitea Bot --- runner-docs/reference/cli.md | 18 +++++++++--------- runner-docs/reference/config-example.md | 15 ++++++++++++++- .../version-5/reference/cli.md | 4 ++-- .../version-5/reference/config-example.md | 3 ++- 4 files changed, 27 insertions(+), 13 deletions(-) diff --git a/runner-docs/reference/cli.md b/runner-docs/reference/cli.md index 3630ebba..9bb58ce8 100644 --- a/runner-docs/reference/cli.md +++ b/runner-docs/reference/cli.md @@ -20,13 +20,13 @@ Usage: gitea-runner [command] Available Commands: - bug-report Print information useful when filing a bug report - cache-server Start a cache server for the cache action - config Generate, read and edit config files - daemon Run as a runner daemon - exec Run workflow locally. - help Help about any command - register Register a runner to the server + bug-report Print information useful when filing a bug report + cache-server Start a cache server for the cache action + config Generate, read and edit config files + daemon Run as a runner daemon + exec Run workflow locally. + help Help about any command + register Register a runner to the server Flags: -c, --config config Config file path. config subcommands fall back to config.yaml in the working directory or next to the executable @@ -91,8 +91,8 @@ Usage: Flags: --artifact-server-addr string Defines the address where the artifact server listens - --artifact-server-path string Defines the path where the artifact server stores uploads and retrieves downloads from. If not specified the artifact server will not start. (default ".") - --artifact-server-port string Defines the port where the artifact server listens (will only bind to localhost). (default "34567") + --artifact-server-path string Defines the path where the artifact server stores uploads and retrieves downloads from, outside the workspace that jobs copy. Defaults to a temporary directory removed on exit. + --artifact-server-port string Defines the port where the artifact server listens (default "34567") --container-architecture string Architecture which should be used to run containers, e.g.: linux/amd64. If not specified, will use host default architecture. Requires Docker server API Version 1.41+. Ignored on earlier Docker server platforms. --container-cap-add stringArray kernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE) --container-cap-drop stringArray kernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE) diff --git a/runner-docs/reference/config-example.md b/runner-docs/reference/config-example.md index 9e797f3b..cb10a895 100644 --- a/runner-docs/reference/config-example.md +++ b/runner-docs/reference/config-example.md @@ -207,7 +207,8 @@ cache: # secret_key_file: "/run/secrets/cache-s3-secret-key" # When true, reuse a cached action instead of fetching from the remote on every job. # A moved tag (e.g. a re-tagged "v6") or an updated branch stays at the cached commit - # until its cache entry expires or is manually removed. + # until its cache entry expires or is manually removed. A cached action whose files changed size + # since it was downloaded is still fetched again, unless an older runner cached it without sizes. #offline_mode: false # Serve the actions cache service v2 API. The actions that use it fall back to v1 on any host # they do not take for GitHub, so reaching it means editing that check out of their own bundle, @@ -318,6 +319,18 @@ kubernetes: #pod_template: {} # Pod templates merged over pod_template, in runs-on order, for jobs whose runs-on has the label they are keyed by. #pod_templates: {} + # Have job pods fetch directories, such as actions, and copies of 64 KiB or more gzipped from the runner over the pod network, + # instead of the runner streaming them through the API server. An init container copies gitea-runner from image into each job pod. + # api: through the API server (default). auto: over the pod network, through the API server for a job pod that + # cannot reach the runner. direct: over the pod network only, so a broken setup fails jobs instead of quietly + # costing API server traffic again. + #transfer: + # mode: api + # # Address and port the runner listens on and job pods reach it at, the outbound IP and a free port when empty. + # host: "" + # port: 0 + # # Image with gitea-runner on its PATH, the runner pod's image when it has a single container and runs in namespace. + # image: "" # Optional local task-admission checks. Disabled by default. When enabled, low # disk space or a failing script pauses new task fetching; existing jobs continue. diff --git a/runner-docs_versioned_docs/version-5/reference/cli.md b/runner-docs_versioned_docs/version-5/reference/cli.md index 3630ebba..fd75ddb9 100644 --- a/runner-docs_versioned_docs/version-5/reference/cli.md +++ b/runner-docs_versioned_docs/version-5/reference/cli.md @@ -91,8 +91,8 @@ Usage: Flags: --artifact-server-addr string Defines the address where the artifact server listens - --artifact-server-path string Defines the path where the artifact server stores uploads and retrieves downloads from. If not specified the artifact server will not start. (default ".") - --artifact-server-port string Defines the port where the artifact server listens (will only bind to localhost). (default "34567") + --artifact-server-path string Defines the path where the artifact server stores uploads and retrieves downloads from, outside the workspace that jobs copy. Defaults to a temporary directory removed on exit. + --artifact-server-port string Defines the port where the artifact server listens (default "34567") --container-architecture string Architecture which should be used to run containers, e.g.: linux/amd64. If not specified, will use host default architecture. Requires Docker server API Version 1.41+. Ignored on earlier Docker server platforms. --container-cap-add stringArray kernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE) --container-cap-drop stringArray kernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE) diff --git a/runner-docs_versioned_docs/version-5/reference/config-example.md b/runner-docs_versioned_docs/version-5/reference/config-example.md index 9e797f3b..d626a33e 100644 --- a/runner-docs_versioned_docs/version-5/reference/config-example.md +++ b/runner-docs_versioned_docs/version-5/reference/config-example.md @@ -207,7 +207,8 @@ cache: # secret_key_file: "/run/secrets/cache-s3-secret-key" # When true, reuse a cached action instead of fetching from the remote on every job. # A moved tag (e.g. a re-tagged "v6") or an updated branch stays at the cached commit - # until its cache entry expires or is manually removed. + # until its cache entry expires or is manually removed. A cached action whose files changed size + # since it was downloaded is still fetched again, unless an older runner cached it without sizes. #offline_mode: false # Serve the actions cache service v2 API. The actions that use it fall back to v1 on any host # they do not take for GitHub, so reaching it means editing that check out of their own bundle,