Git Repository URL Suffix
The ensure_git_suffix key tells Antora whether it should append the .git extension, if absent, to the URL of a remote content source.
If you’re using GitHub or GitLab, you don’t need to define this key in your playbook as the default will suffice.
However, if you’re using Team Foundation Server (TFS) or Azure DevOps, read on.
Default git repository URL suffix
By default, the ensure_git_suffix key is assigned the value true.
When ensure_git_suffix is true, Antora instructs the git client to automatically append .git to any remote content sources repository URLs that are missing the suffix.
Some git services don’t recognize the URL if it contains the .git extension. Therefore, it’s necessary for this behavior to be configurable.
ensure_git_suffix key
The optional ensure_git_suffix key is set under the git key in a playbook.
It accepts a boolean value.
- false
-
Antora won’t append .git to any URL for a remote content source that are missing the .git suffix.
- true
-
Default value. Antora will append .git to any remote content sources repository URLs that are missing the .git suffix.
If you use Team Foundation Server (TFS) or Azure DevOps, you may need to set ensure_git_suffix to false if your content sources repositories fail to clone.
git:
ensure_git_suffix: false