diff --git a/runner-docs/reference/config-example.md b/runner-docs/reference/config-example.md index be5380dd..137228ef 100644 --- a/runner-docs/reference/config-example.md +++ b/runner-docs/reference/config-example.md @@ -76,9 +76,9 @@ runner: #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 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. On runners with kubernetes labels it - # removes such jobs' pods and Secrets. + # tear down once unused and 10 minutes old, which would otherwise hold a subnet of the + # daemon address pool and the job's workspace contents until the host is rebuilt. On + # runners with kubernetes labels it removes such jobs' pods and Secrets. #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 @@ -91,6 +91,9 @@ runner: # Flush logs immediately when the buffer reaches this many rows. # This ensures bursty output (e.g., npm install) is delivered promptly. #log_report_batch_size: 100 + # The lowest severity of the runner's own messages (not step output) that are sent to the + # job log between steps: trace, debug, info, warn, error. Default if omitted: follow log.level. + #log_report_level: info # The interval for reporting task state (step status, timing) to the Gitea instance. # State is also reported on step transitions (start/stop) and after each log flush. #state_report_interval: 5s @@ -103,11 +106,12 @@ runner: # it replaces https://github.com with the value here, which is useful for some special network environments. #github_mirror: '' # Extra HTTP headers for runner API requests to Gitea, e.g. reverse proxy authentication. - # Not used for action clones, artifacts, job summaries or jobs. Runner headers take precedence. + # Not used for action downloads, artifacts, job summaries or jobs. Runner headers take precedence. # Dropped on redirects to another hostname, or to HTTP if the instance URL uses HTTPS. #extra_headers: # X-Proxy-Token: 'example' - # When true (the default), fetch only the requested ref of an action repository (e.g. actions/checkout@v4) at depth 1 instead of cloning every branch's full history. + # When true (the default), clone only the requested ref at depth 1 instead of every branch's full history. Actions download as + # archives, so this applies to reusable workflows and to actions whose host serves no archive of them. # Set to false to clone the full history. #action_shallow_clone: true # When true (the default), inject the ACT=true environment variable into jobs.