Runtime Keys :: Antora Docs

runtime键

全局日志、控制台输出、获取和缓存目录属性在playbook文件中在runtime键下定义。这些设置在Antora启动时应用于Antora流水线。

示例 1. antora-playbook.yml

runtime: (1)
  cache_dir: ./.cache/antora (2)
  fetch: true (3)
  log: (4)
    level: error (5)

1	可选的`runtime`键
2	可选的`cache_dir`键
3	可选的`fetch`键
4	可选的`log`键
5	可选的`level`键

runtime键及其接受的键值对是可选的。如果playbook中未设置runtime，Antora将使用默认的缓存目录、获取和日志设置。或者，这些键可以从CLI分配，或者，除了fetch之外，可以使用环境变量。

log键

log键是可选的。如果在playbook中设置了它，必须将其嵌套在runtime键下。log键接受一系列内置的键值对，用于配置日志级别（level）、失败级别（failure_level）和显示格式（format）。

示例 2. antora-playbook.yml

runtime:
  log: (1)
    format: json (2)
    failure_level: warn (3)
    level: all (4)
    level_format: number (5)
    destination: (6)
      file: ./antora.log (7)
      append: true (8)
      buffer_size: 4096 (9)
      sync: false (10)

1	可选的`log`类别键嵌套在`runtime`类别键下。
2	可选的`format`键嵌套在`log`类别键下。
3	可选的`failure_level`键嵌套在`log`类别键下。
4	可选的`level`键嵌套在`log`类别键下。
5	可选的`level_format`键嵌套在`log`类别键下。
6	可选的`destination`类别键嵌套在`log`类别键下。
7	可选的`file`键嵌套在`destination`类别键下。
8	可选的`append`键嵌套在`destination`类别键下。
9	可选的`buffer_size`键嵌套在`destination`类别键下。
10	可选的`sync`键嵌套在`destination`类别键下。

如果在playbook中设置了level、failure_level、format或level_format，它们必须嵌套在log类别键下。如果在playbook中未明确定义这些键，Antora运行时会自动应用默认值。这些默认值会在Antora运行时自动应用，如果它们未在playbook中明确定义，可以使用相应的命令行选项或环境变量。

如果在playbook中设置了file、append、buffer_size或sync，它们必须嵌套在destination类别键下。

如果在Antora完全配置playbook之前抛出致命错误，则不会遵守日志设置。在这种情况下，错误消息仅使用预配置的记录器直接打印到标准错误(stderr)。

可用的运行时键

运行时键描述必需

运行时键	描述	必需
cache_dir	指定远程内容源git仓库和UI包的缓存目录。	否
fetch	当设置为`true`时，`fetch`键会在每次Antora运行时刷新缓存中的文件。	否
log.failure_level	设置日志级别容忍度，当达到或超过时，Antora将在退出时以非零退出代码失败。接受值`warn`、`error`、`fatal`和`none`。默认值为`fatal`。值`none`会导致Antora始终以零退出代码退出。	否
log.format	设置日志消息的格式。接受值`pretty`和`json`。在CI环境中，默认值为`json`，在其他所有环境中默认值为`pretty`。	否
log.level	设置必须满足的消息的最小严重性阈值级别以记录。接受值`all`、`debug`、`info`、`warn`、`error`、`fatal`和`silent`。默认值为`warn`。值`silent`会关闭记录器。	否
log.level_format	设置日志级别的表达方式格式。仅在`log.format`为`json`时适用。接受值`label`和`number`。默认值为`label`。	否
log.destination.file	设置写入日志消息的目标文件或流。默认值（`stdout`或`stderr`）取决于日志格式。	否
log.destination.append	配置是否在写入之前截断（即清除）文件。默认值为`false`，表示截断文件。	否
log.destination.buffer_size	设置用于缓冲日志消息的内存量。一旦缓冲区达到此大小，缓冲的消息将批量写入目标。默认值为`0`，表示关闭此行为。	否
log.destination.sync	配置是否使用同步或异步操作将日志消息写入目标。默认值为`true`，表示日志消息是同步写入的（阻塞）。	否

cache_dir

指定远程内容源git仓库和UI包的缓存目录。

否

fetch

当设置为true时，fetch键会在每次Antora运行时刷新缓存中的文件。

否

log.failure_level

设置日志级别容忍度，当达到或超过时，Antora将在退出时以非零退出代码失败。接受值warn、error、fatal和none。默认值为fatal。值none会导致Antora始终以零退出代码退出。

否

log.format

设置日志消息的格式。接受值pretty和json。在CI环境中，默认值为json，在其他所有环境中默认值为pretty。

否