Git 插件

plugins 类别键用于指定要加载到 git 客户端中的插件的位置。这组插件是固定的,并使用预定的名称引用。这些插件提供了一定程度上的控制,用于控制 Antora 使用的 git 客户端的操作方式。插件的集合可能会随时间增长。

插件键

plugins 键设置在 git 类别键 下。

示例 1. antora-playbook.yml
git: (1)
  plugins: (2)
1 输入父键 git,后跟冒号(:),然后按 Enter 键。
2 plugins 类别键嵌套在 git 类别键下。输入键的名称 plugins,后跟冒号(:),然后按 Enter 键。

plugins 键接受一个映射(即键值对),指定要加载到 git 客户端中的预定插件的位置。

credential_manager 键

credential_manager 键是 git.plugins 类别键的子级。它提供了一种指定 git 客户端要使用的自定义凭据管理器的方式。每当 git 客户端与需要身份验证的存储库交互时,都会调用凭据管理器插件。

示例 2. antora-playbook.yml
git:
  plugins: (1)
    credential_manager: ./my-git-credential-manager-plugin.js (2)
1 credential_manager 类别键嵌套在 git.plugins 类别键下。
2 输入键名 credential_manager,后跟冒号(:)。冒号后,输入一个空格,然后输入标识凭据管理器插件代码所在位置的 require 请求。

当设置了 credential_manager 键时,Antora 将使用 require 请求来定位并加载插件的代码,并将其注册到 git 客户端中。凭据管理器插件的 API 及其工作原理在 配置自定义凭据管理器 中有描述。

http 键

http 键是 git.plugins 类别键的子级。它提供了一种指定 git 客户端要使用的自定义 HTTP 请求处理程序的方式。每当 git 客户端与 git 存储库通信时(所有这些都是通过 HTTP 完成的),都会调用 http 插件。

示例 3. antora-playbook.yml
git:
  plugins: (1)
    http: ./my-git-http-plugin.js (2)
1 http 类别键嵌套在 git.plugins 类别键下。
2 输入键名 http,后跟冒号(:)。冒号后,输入一个空格,然后输入标识 HTTP 插件代码所在位置的 require 请求。

当设置了 http 键时,Antora 将使用 require 请求来定位并加载插件的代码,并将其注册到 git 客户端中。

http 插件的 API 由 isomorphic-git 文档 提供。它涉及导出一个名为 request 的异步函数,该函数接受 url、method、headers 和 body 作为参数,并将请求的结果作为具有 url、method、headers、body、statusCode 和 statusMessage 属性的对象返回。在该函数中,您可以使用自己的 HTTP 客户端来完成请求。