获取更新

每当您想要从远程内容源仓库和UI捆绑快照中检索更新时,请使用fetch关键字。

获取操作

从playbook或CLI激活fetch关键字会导致Antora在每次运行时执行以下两个操作:

  1. 为Antora克隆的所有远程内容源仓库运行获取操作,或以其他方式克隆它们。

  2. 如果远程UI捆绑被标记为快照,即使已经下载过,也会下载远程UI捆绑。

Antora仅为远程内容源获取更新,因为克隆由Antora管理。Antora永远不会为本地内容源(即本地git仓库)获取更新。换句话说,Antora不会在本地git仓库上运行git fetchgit pull。这样做会使它们处于不一致的状态,或者干扰作者的工作。Antora将本地内容仓库的状态管理留给作者。

fetch关键字

当Antora第一次运行playbook时,它会克隆任何远程内容源git仓库,并将UI捆绑下载到Antora缓存目录中。在后续运行中,Antora会在缓存文件夹中解析这些资源,有效地离线运行。

您可以通过将可选的fetch关键字设置为true来指示Antora刷新缓存。在playbook中,fetch关键字配置在运行时关键字下。

示例1. antora-playbook.yml
runtime:
  fetch: true

获取选项

您无需直接修改playbook文件以设置此关键字。您可以从CLI使用--fetch选项。

$ antora --fetch antora-playbook.yml

--fetch选项会覆盖playbook文件中分配给fetch关键字的值。