Git Keys

在git下配置的playbook密钥控制Antora使用的git客户端的行为。

git密钥

git密钥包含所有与git相关的playbook密钥，例如git凭据、自动URL后缀和插件。

示例1. antora-playbook.yml 
git: (1)
  fetch_concurrency: 3 (2)
  ensure_git_suffix: false (3)
  credentials: (4)
    path: ./.git-credentials (5)
  plugins: (6)
    credential_manager: ./system-git-credential-manager.js (7)
  read_concurrency: 5 (8)
1 可选的git类别密钥
2 可选的fetch_concurrency密钥，用于限制并发获取操作的数量
3 可选的ensure_git_suffix密钥
4 可选的credentials类别密钥
5 path密钥用于指定可选凭据的位置；与contents密钥互斥
6 可选的plugins类别密钥
7 可选的credential_manager密钥
8 可选的read_concurrency密钥，用于限制并发读取操作的数量（在存储库获取后）

git类别密钥及其接受的子密钥都是可选的。当playbook中不存在git密钥时，Antora将回退到使用git客户端的默认配置。

可用的git密钥

Git密钥 描述 必需

credentials.contents

接受与git凭据存储使用的格式匹配的git凭据数据。

否

credentials.path

接受与git凭据存储使用的格式匹配的git凭据文件的文件系统路径。

否

fetch_concurrency

1默认值。接受任何正整数或零。当非零时，将并发获取操作的数量限制为指定值。当为零时，不限制并发获取操作的数量。

否

plugins.credential_manager

接受一个require请求，指定提供自定义凭据管理器的代码位置。

否

plugins.http

接受一个require请求，指定提供自定义HTTP请求处理程序的代码位置。

否

ensure_git_suffix

true默认值。当为true时，此密钥指示git客户端自动将.git附加到内容源存储库的URL（如果不存在）。

否

read_concurrency

0默认值（实际上没有限制）。接受任何正整数或零。当非零时，将读取操作的数量限制为指定值。当为零时，不限制读取操作的数量。

否