环境变量
Antora识别一些映射到playbook中键的环境变量。这些环境变量可用于在不修改playbook文件的情况下为不同环境配置Antora。
什么是环境变量?
环境变量是您终端中的持久变量(即key=value对),可供您在提示符下执行的所有命令使用。这个功能允许基于命令运行的环境来改变命令的行为。例如,您可以在持续集成(CI)或发布环境中使用环境变量来启用默认情况下未启用的行为。
您可以使用echo
命令输出环境变量的当前值。在Linux或macOS终端中,输入:
$ echo $PATH
在Windows命令提示符中,输入:
$ echo %PATH%
在Windows Powershell中,输入:
$ echo $env:PATH
使用Antora不需要环境变量。您可以使用相应的命令行选项或在playbook中使用匹配的键来配置这些变量。
优先级
环境变量优先于playbook文件中定义的键。但是,对于一个键,CLI选项优先于该键的环境变量。
如果环境变量(如URL
或https_proxy
)已在您的环境中设置,并且您希望在运行antora
命令时(即单次调用)暂时取消设置它,您可以使用env
命令:
$ env -u URL antora antora-playbook.yml
另一个选项是在子shell中运行antora
命令。在子shell中,您可以取消设置一个环境变量,而不会影响主shell或操作系统的环境。
$ (unset URL; antora antora-playbook.yml)
请记住,环境变量优先于playbook文件中定义的键。因此,如果您得到了意料之外的结果,请始终检查您的环境变量,看看它们是否是问题的根源。
变量和格式
以下表格总结了您可以使用的环境变量,以控制Antora的操作。
变量 | 格式 | 默认值 | 了解更多 |
---|---|---|---|
字符串 |
<用户缓存>/antora |
查看 cache_dir键 和 --cache-dir 选项 |
|
字符串 |
未设置 |
||
字符串 |
未设置 |
查看 file键 和 --log-file 选项 |
|
字符串 |
|
查看 format键 和 --log-format 选项 |
|
字符串 |
|
查看 level键 和 --log-level 选项 |
|
字符串 |
|
查看 level_format键 和 --log-level-format 选项。仅在日志格式为 |
|
|
字符串 |
未设置 |
查看 私有仓库认证 |
|
字符串 |
未设置 |
|
|
字符串 |
未设置 |
|
|
字符串 |
未设置 |
|
|
字符串 |
未设置 |
|
|
字符串 |
未设置 |
查看 no_proxy键 和 --noproxy 选项。请注意,CLI选项的名称与环境变量和playbook键的名称不同。 |
字符串 |
未设置 |