Git Keys
The playbook keys configured under git
control the behavior of the git client used by Antora.
git key
The git
key holds all the git-related playbook keys, such as the git credentials, automatic URL suffix, and plugins.
git: (1)
fetch_concurrency: 5 (2)
ensure_git_suffix: false (3)
credentials: (4)
path: ./.git-credentials (5)
plugins: (6)
credential_manager: ./system-git-credential-manager.js (7)
1 | Optional git category key |
2 | Optional fetch_concurrency key to limit number of concurrency fetch operations |
3 | Optional ensure_git_suffix key |
4 | Optional credentials category key |
5 | path key to specify the location of optional credentials; mutually exclusive with the contents key |
6 | Optional plugins category key |
7 | Optional credential_manager key |
The git
category key and the child keys it accepts are all optional.
When the git
key isn’t present in the playbook, Antora falls back to using the default configuration for the git client.
Available git keys
Git Keys | Description | Required |
---|---|---|
Accepts git credentials data matching the format used by the git credential store. |
No |
|
Accepts a filesystem path to a git credentials file matching the format used by the git credentials store. |
No |
|
|
No |
|
|
No |
|
Accepts a require request that specifies the location of the code that provides a custom credential manager. |
No |
|
Accepts a require request that specifies the location of the code that provides a custom HTTP request handler. |
No |