日志失败级别

failure_level键指定了严重性阈值,当达到或超过该阈值时,会导致Antora以非零(即失败)退出码退出。

需要明确的是,这个设置并不会阻止Antora的运行。相反,它仅影响Antora运行的进程的退出码值。大多数CI环境会解释这个值。

默认失败级别

在playbook中明确为failure_level键分配一个值是可选的。如果在playbook中未设置它,也未使用--log-failure-level选项ANTORA_LOG_FAILURE_LEVEL变量指定它,Antora会在运行时将值fatal分配给该键。如果记录的消息达到fatal严重性阈值,Antora将以非零退出码退出。

failure_level键

failure_level键配置在playbook中的运行时和日志键下。

示例1. antora-playbook.yml
runtime:
  log:
    failure_level: error

该键接受以下内置值:

  • fatal(默认)

  • error

  • warn

  • none

这些值对应于Antora分配给日志消息的严重级别。除非值为none,如果记录的消息达到或超过分配给failure_level的值,Antora将以非零退出码退出。当值为none时,即使抛出未处理的错误,Antora也总是以零退出码退出。请注意,当Antora的记录器关闭时,failure_level键及其值不会被应用。

强制零退出码

failure_level键被分配值none时,Antora总是以退出码零(0)退出,即使遇到致命错误。

指定失败级别

让我们在playbook中为failure_level键分配值warn,如示例2所示。

示例2. 为failure_level键分配warn严重性阈值
runtime:
  log:
    failure_level: warn

只要不遇到任何致命错误,Antora将完成站点生成,并在记录任何严重性为warn或更高的消息时以非零退出码退出。如果没有记录任何警告、错误或致命消息,Antora将以零(0)退出码退出。也就是说,您的站点成功构建,没有任何错误或潜在问题!

日志失败级别选项

或者,您可以使用CLI中的--log-failure-level选项来分配一个失败阈值。

$ antora --log-failure-level=warn antora-playbook.yml

--log-failure-level选项会覆盖分配给failure_level键或ANTORA_LOG_FAILURE_LEVEL环境变量的值。