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.

Example 1. antora-playbook.yml
git: (1)
  ensure_git_suffix: false (2)
  credentials: (3)
    path: ./.git-credentials (4)
  plugins: (5)
    credential_manager: ./system-git-credential-manager.js (6)
1 Optional git category key
2 Optional ensure_git_suffix key
3 Optional credentials category key
4 path key to specify the location of optional credentials; mutually exclusive with the contents key
5 Optional plugins category key
6 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

credentials.contents

Accepts git credentials data matching the format used by the git credential store.

No

credentials.path

Accepts a filesystem path to a git credentials file matching the format used by the git credentials store.

No

ensure_git_suffix

true by default. When true, this key instructs the git client to automatically append .git to content sources repository URLs if absent.

No

plugins.credential_manager

Accepts a require request that specifies the location of the code that provides a custom credential manager.

No

plugins.http

Accepts a require request that specifies the location of the code that provides a custom HTTP request handler.

No