From b0b0c5090eaae1b3bc1f297b9f207b83eb2c148a Mon Sep 17 00:00:00 2001 From: Gitea Bot Date: Mon, 21 Sep 2026 19:51:28 +0000 Subject: [PATCH] Update the runner reference pages (#555) 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. --------- Co-authored-by: Lunny Xiao Reviewed-on: https://gitea.com/gitea/docs/pulls/555 Reviewed-by: Lunny Xiao Co-authored-by: Gitea Bot --- runner-docs/reference/config-example.md | 12 +++++++----- .../version-3/reference/config-example.md | 19 +++++++++++-------- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/runner-docs/reference/config-example.md b/runner-docs/reference/config-example.md index 53b31a66..f1c07be2 100644 --- a/runner-docs/reference/config-example.md +++ b/runner-docs/reference/config-example.md @@ -192,10 +192,11 @@ cache: # 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. #offline_mode: false - # Serve the actions cache service v2 API. The actions that use it refuse any host they do not - # take for GitHub, so reaching it means editing that check out of their own bundle, put back - # after the copy into the job. That edit is made either way, this only governs the API - # advertised. A bundle that does not match is left alone. With v2, uploads need a reachable cache. + # 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, + # put back after the copy into the job. That edit is made either way, this only governs the API + # advertised. A bundle that does not match is left alone. With v2, artifact uploads go via the + # cache server unless container jobs cannot reach its Docker network. #v2: true # How the cache server discards entries, ignored when external_server is set since that # server applies its own. Leave a setting out for its default; 0s or 0 turns the three @@ -275,7 +276,8 @@ container: #docker_timeout: 0s # Mount the workspace from a host directory instead of a Docker volume, so jobs # can bind-mount it by its own path into sibling containers (".:/app" in docker - # compose). Not needed when workflows use the GITEA_DOCKER_WORKSPACE variable. + # compose). Not needed when jobs get the Docker proxy or workflows use the + # GITEA_DOCKER_WORKSPACE variable. # The workspace parent directory must be mounted into the runner container. #bind_workdir: false # How long a job waits for a service container that declares a healthcheck to become 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 30cf5b32..f1c07be2 100644 --- a/runner-docs_versioned_docs/version-3/reference/config-example.md +++ b/runner-docs_versioned_docs/version-3/reference/config-example.md @@ -68,11 +68,12 @@ runner: # scratch directories (left behind when a host cleanup delete stalls) older than # this duration. Setting either workdir_cleanup_age or idle_cleanup_interval to 0 # (or any non-positive value) disables stale-directory cleanup entirely, along with - # the docker network cleanup below. + # the docker network and volume cleanup below. #workdir_cleanup_age: 24h # Cadence for the idle cleanup pass. Besides the directories above, on runners that use - # docker it removes the per-job networks of jobs this runner did not live to tear down, - # which would otherwise hold a subnet of the daemon address pool until the host is rebuilt. + # docker it removes the per-job networks and volumes of jobs this runner did not live to + # tear down, which would otherwise hold a subnet of the daemon address pool and the job's + # workspace contents until the host is rebuilt. #idle_cleanup_interval: 10m # The base interval for periodic log flush to the Gitea instance. # Logs may be sent earlier if the buffer reaches log_report_batch_size @@ -191,10 +192,11 @@ cache: # 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. #offline_mode: false - # Serve the actions cache service v2 API. The actions that use it refuse any host they do not - # take for GitHub, so reaching it means editing that check out of their own bundle, put back - # after the copy into the job. That edit is made either way, this only governs the API - # advertised. A bundle that does not match is left alone. With v2, uploads need a reachable cache. + # 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, + # put back after the copy into the job. That edit is made either way, this only governs the API + # advertised. A bundle that does not match is left alone. With v2, artifact uploads go via the + # cache server unless container jobs cannot reach its Docker network. #v2: true # How the cache server discards entries, ignored when external_server is set since that # server applies its own. Leave a setting out for its default; 0s or 0 turns the three @@ -274,7 +276,8 @@ container: #docker_timeout: 0s # Mount the workspace from a host directory instead of a Docker volume, so jobs # can bind-mount it by its own path into sibling containers (".:/app" in docker - # compose). Not needed when workflows use the GITEA_DOCKER_WORKSPACE variable. + # compose). Not needed when jobs get the Docker proxy or workflows use the + # GITEA_DOCKER_WORKSPACE variable. # The workspace parent directory must be mounted into the runner container. #bind_workdir: false # How long a job waits for a service container that declares a healthcheck to become