Antora 3.1中的新功能

Antora 3.1.7

发布日期: 2024.01.02 | 问题标签: 3.1.7

已解决问题

变更

问题 #1099

  • 保留包装错误中的所有信息（内容聚合器，UI加载器，文件发布器）

问题 #1098

  • 升级isomorphic-git以包含正确处理网络错误的补丁（内容聚合器）

  • 在系列中重试失败的获取/克隆操作时，在日志消息中添加原因（内容聚合器）

问题 #1101

  • 清除不使用自定义代理的git HTTP连接上的超时和保持活动设置（内容聚合器）

(无问题)

  • 如果playbook只有一个内容源URL，则不要重试失败的克隆/获取操作（内容聚合器）

Antora 3.1.6

发布日期: 2023.12.19 | 问题标签: 3.1.6

已解决问题

新增

问题 #1096

添加git.read_concurrency playbook键以控制一次加载多少个git索引到内存中（playbook-builder）

变更

问题 #1096

  • 将git.fetch_concurrency的默认值更改为1（playbook-builder）。

  • 如果发生意外的网络错误，则将git克隆/获取错误标记为可恢复（内容聚合器）。

  • 将加载（获取或克隆）存储库的步骤与扫描存储库以发现引用和启动路径并收集文件的步骤解耦（内容聚合器）。

(无问题)

  • 如果起始路径为空，则不要两次读取git树；在同一函数中向树对象添加dirname（内容聚合器）。

  • 如果克隆存储库失败，则用不完整的标记填充进度条（内容聚合器）。

  • 如果服务器请求凭据，然后发送404响应，则提到凭据可能已被拒绝（内容聚合器）。

修复

问题 #1070

将主机名添加到忽略列表中，以防止主机名属性在记录的错误中修改记录器名称（记录器）

问题 #1096

如果git.fetch_concurrency > 1且发生意外错误，则串行重试失败的获取/克隆操作（内容聚合器）

Antora 3.1.5

发布日期: 2023.11.22 | 问题标签: 3.1.5

已解决问题

变更

问题 #1094

修复当路径无扩展名且匹配父文件夹时的相对路径计算

将gulp-vinyl-zip依赖项更改为@vscode/gulp-vinyl-zip以消除警告（无功能更改）。

修复

问题 #1092

如果图像宏的目标解析为未发布的图像，则不要加载AsciiDoc失败

问题 #1095

在检索远程UI包时发生网络连接时，在聚合内容后隔离重试loadUi

Antora 3.1.4

发布日期: 2023.06.07 | 问题标签: 3.1.4

已解决问题

修复

问题 #1063

如果URL中的凭据失败，则尝试来自凭据存储的凭据。

问题 #1064

考虑至少有一个远程分支的非托管裸存储库中的本地分支。

Antora 3.1.3

发布日期: 2023.04.02 | 问题标签: 3.1.3

已解决问题

修复

问题 #1049

在使用pino-std-serializers >= 6.1时，恢复日志输出中的错误堆栈

  • 在检索远程UI包时正确处理连接错误

  • 如果虚拟文件上未设置pub或pub.moduleRootPath属性，则不要加载AsciiDoc失败

Antora 3.1.2

发布日期: 2022年10月28日 | 问题标签: 3.1.2

已解决问题

已修复

问题 #1010

修复了如果内容源URL中嵌入的凭据为空且存储库需要认证时出现无限认证循环的问题。

问题 #1018

修复了如果内容源上worktrees键的值为~（null）且至少指定了一个分支时出现崩溃的问题。

问题 #1020

添加了防护措施，防止ContentCatalog#registerSiteStartPage注册别名循环。

问题 #1022

将计算默认日志格式的逻辑与进程环境解耦。

问题 #1024

在创建静态路由时保留目标，如果目标是绝对URL。

问题 #1025

允许内容聚合器解析content.branches和content.tags playbook键的值。

站点生成器

在站点生成器中查找playbook.env上的IS_TTY，以将检查与进程环境解耦。

Antora 3.1.1

发布日期: 2022年09月21日 | 问题标签: 3.1.1

已解决问题

已更改

问题 #1004

如果IS_TTY环境变量设置为true，默认使用漂亮的日志格式。如果IS_TTY环境变量设置为true，则打印成功消息。有关更多信息，请参阅日志格式。

已修复

问题 #1003

防止被忽略的日志消息覆盖下一个报告的日志消息。

更新至问题 #984

为需要resolveIncludeFile函数的公共导出定义@antora/asciidoc-loader/include/resolve-include-file。

站点生成器

不要求自定义输出提供程序返回报告对象。

命令行界面

如果找不到记录器，在关闭期间将错误消息打印到stderr而不是崩溃。

Antora 3.1.0

发布日期: 2022.08.22 | 问题标签: 3.1.0

Antora 3.1.0版本的亮点包括：

您可以在下面找到此版本中解决的问题的摘要。

已解决的问题

已添加

问题 #221

如果未找到内容源的引用，则记录信息消息。

问题 #354

如果设置了当前页面的编辑URL，则将其分配给page-edit-url AsciiDoc属性。如果页面的来源是私有的，则定义布尔值page-origin-private AsciiDoc属性。

问题 #525

将解析的组件版本描述符附加到源对象的descriptor属性上。

问题 #814

向内容目录和UI目录添加removeFile方法。

问题 #921

使用最新组件版本的版本字符串值定义page-component-latest-version AsciiDoc属性。如果页面在组件的最新版本中，则定义布尔值page-component-version-is-latest AsciiDoc属性。有关更多信息，请参阅内在页面属性。

问题 #978

为所有包定义导出项，锁定可以导出到公共API的路径。

问题 #981

解析在playbook（antora-playbook.yml）和组件版本描述符（antora.yml）中定义的AsciiDoc属性中的属性引用，遵循任何转义的属性引用。

问题 #988

  • 在结构化日志消息中，为源对象添加reftype键，其值为分支或标签。

  • 向源对象添加reftype属性，明确标识git引用的类型（分支或标签）。

  • 如果适用，在结构化日志消息中为源对象添加remote键，其值为远程跟踪分支。

  • 添加remote属性到源对象，以标识远程跟踪分支。

  • 如果适用，在结构化日志消息中为源对象添加local键，其值为本地存储库的路径。

已更改

问题 #900

在本地内容源或UI捆绑目录中，对于损坏或循环符号链接的错误消息中包含目标。

问题 #979

将Node.js 16.0.0设置为最低支持的Node.js版本。升级需要Node.js > 12的依赖项，并删除解决方法。

问题 #982

将整理AsciiDoc属性的逻辑移动到辅助函数中。使用辅助函数从playbook和组件版本中整理AsciiDoc属性。

问题 #985

为错误消息添加上下文并保留原因，如果在读取补充UI文件时发生故障。

问题 #986

如果工作树中的文件消失或无法读取，则记录警告消息，而不是抛出致命错误。

问题 #988

在日志和错误消息中一致地格式化源信息。

问题 #993

当分支或标签是本地但不是从工作树中获取时，将worktree属性设置为false。使用隔离的Handlebars环境，而不是默认（全局）环境。

已修复

  • 在漂亮的日志格式中，如果行缺失，则不在文件路径后附加undefined。

  • 使有关缺少页面布局的警告消息与其他日志消息一致。

已移除

Node.js 12和14支持

Antora不再支持Node.js < 16（特别是放弃对Node.js 12和14的支持），因为这些Node.js版本线现在已经终止。此更改与Antora的Node.js支持政策一致。

Antora 2已终止支持

Antora 2已终止支持。请查看升级Antora上的清单，了解在升级到Antora 3.1之前应对源内容进行的更改，包括在Asciidoctor 2.2中引入的Asciidoctor更新的AsciiDoc语法和Antora配置。

感谢！

最重要的是，特别感谢所有帮助使Antora变得更好的人们。在Antora 3.1的开发过程中，Antora社区提供了宝贵的反馈和测试帮助。

我们还要感谢以下人员为此版本做出贡献：

Gautier de Saint Martin Lacaze（@jabby）

向contentCatalog和uiCatalog添加removeFile方法（#814）。