act_runner/_config.yaml
2025-04-10 09:53:36 +08:00

119 lines
5.5 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 示例配置文件,可以直接复制作为默认配置文件,无需修改。
# 你不需要将此文件复制到你的实例中,
# 只需运行 `./act_runner generate-config > config.yaml` 即可生成配置文件。
log:
# 日志级别,可以是 trace, debug, info, warn, error, fatal
level: info
runner:
# 注册结果的存储位置。
file: .runner
# 同时执行的任务数量。
capacity: 1
# 运行任务时的额外环境变量。
envs:
A_TEST_ENV_NAME_1: a_test_env_value_1
A_TEST_ENV_NAME_2: a_test_env_value_2
# 从文件中读取的额外环境变量。
# 如果为空或文件不存在,则忽略。
env_file: .env
# 任务完成的超时时间。
# 请注意Gitea 实例也有一个任务超时时间(默认为 3 小时)。
# 因此,如果 Gitea 实例的超时时间比此时间短,任务可能会被 Gitea 实例停止。
timeout: 3h
# 关闭时等待正在运行的任务完成的超时时间。
# 在此超时时间后仍未完成的任务将被取消。
shutdown_timeout: 0s
# 是否跳过验证 Gitea 实例的 TLS 证书。
insecure: false
# 从 Gitea 实例获取任务的超时时间。
fetch_timeout: 5s
# 从 Gitea 实例获取任务的间隔时间。
fetch_interval: 2s
# Runner 的标签用于确定 Runner 可以运行哪些任务以及如何运行它们。
# 例如:"macos-arm64:host" 或 "ubuntu-latest:docker://gitea/runner-images:ubuntu-latest"
# 更多 Gitea 提供的镜像可以在 https://gitea.com/gitea/runner-images 找到。
# 如果注册时为空,则会要求输入标签。
# 如果执行 `daemon` 时为空,则会使用 `.runner` 文件中的标签。
labels:
# 优先使用 ubuntu-latest
# - "ubuntu-20.04:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-20.04"
# - "ubuntu-22.04:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-22.04"
- "ubuntu-latest-slim:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-latest-slim"
- "ubuntu-latest:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-latest"
# - "ubuntu-20.04-slim:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-20.04-slim"
# - "ubuntu-22.04-slim:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-22.04-slim"
# - "ubuntu-20.04-full:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-20.04-full"
# - "ubuntu-22.04-full:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-22.04-full"
# - "ubuntu-latest-full:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-latest-full"
# 特有镜像(标记环境) CN = 国内 canton = 局域网设备 hk = 香港 global = 墙外设备
# - "cn:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-latest"
# - "canton:docker://docker.martin98.com/library/gitea/runner-images:ubuntu-latest"
# - "hk:docker://docker.gitea.com/runner-images:ubuntu-latest"
# - "us:docker://docker.gitea.com/runner-images:ubuntu-latest"
# - "global:docker://docker.gitea.com/runner-images:ubuntu-latest"
cache:
# 启用缓存服务器以使用 actions/cache。
enabled: true
# 存储缓存数据的目录。
# 如果为空,缓存数据将存储在 $HOME/.cache/actcache。
dir: ""
# 缓存服务器的主机地址。
# 这不是监听的地址,而是从任务容器连接的地址。
# 因此 0.0.0.0 不是一个好的选择,留空以自动检测。
host: ""
# 缓存服务器的端口。
# 0 表示使用随机可用端口。
port: 0
# 外部缓存服务器 URL。仅在启用时为有效。
# 如果指定act_runner 将使用此 URL 作为 ACTIONS_CACHE_URL而不是自己启动服务器。
# URL 通常应以 "/" 结尾。
external_server: ""
container:
# 指定容器将连接的网络。
# 可以是 host, bridge 或自定义网络的名称。
# 如果为空act_runner 将自动创建一个网络。
network: ""
# 启动任务容器时是否使用特权模式Docker-in-Docker 需要特权模式)。
privileged: false
# 启动容器时使用的其他选项(例如 --add-host=my.gitea.url:host-gateway
options:
# 任务工作目录的父目录。
# 注意:路径的第一个 '/' 不需要添加act_runner 会自动添加。
# 如果路径以 '/' 开头,则 '/' 将被删除。
# 例如,如果父目录是 /path/to/my/dirworkdir_parent 应为 path/to/my/dir
# 如果为空,将使用 /workspace。
workdir_parent:
# 可以将卷(包括绑定挂载)挂载到容器中。支持 Glob 语法,参见 https://github.com/gobwas/glob
# 可以指定多个卷。如果序列为空,则不能挂载任何卷。
# 例如,如果只允许容器挂载 `data` 卷和 `/src` 中的所有 json 文件,应将配置更改为:
# valid_volumes:
# - data
# - /src/*.json
# 如果要允许任何卷,请使用以下配置:
# valid_volumes:
# - '**'
valid_volumes: [ ]
# 使用指定的 docker 客户端主机覆盖默认主机。
# 如果为空act_runner 将自动查找可用的 docker 主机。
# 如果为 "-"act_runner 将自动查找可用的 docker 主机,但不会将 docker 主机挂载到任务容器和服务容器。
# 如果不为空或 "-",将使用指定的 docker 主机。如果无效,将返回错误。
docker_host: ""
# 即使镜像已存在,也强制拉取 docker 镜像。
force_pull: true
# 即使镜像已存在,也强制重新构建 docker 镜像。
force_rebuild: false
host:
# 任务工作目录的父目录。
# 如果为空,将使用 $HOME/.cache/act/。
workdir_parent: