Add ability to enable, disable, or filter worktrees
Once #742 (closed) is resolved, it will be possible to use multiple worktrees with Antora. To provide better control of this behavior, it should be possible to enable, disable, or filter these worktrees.
This behavior will be controlled using the new worktrees
key on a content source. For example:
content:
sources:
- url: .
branches: v*
worktrees: true
Here are the possible values of the worktrees
key:
-
true
(enable the use of all worktrees) -
false
(or~
) (disable the use of all worktrees) -
.
(enable only the main worktree) (default) -
*
(enable only the linked worktrees) -
., v2*
(enable the main worktree and the linked worktrees that match the specified filter; the main worktree can only be referred using.
)
The default mode should match the existing behavior, which is to automatically use the main worktree if the current branch matches a content branch.
Edited by Dan Allen