标签
tags
键接受精确标签名称和匹配标签名称的模式列表。
我们通常建议不要从标签中提取文档。如果您确实使用标签,我们建议使用专门的文档标签,而不是重用标签用于软件发布。您可以在内容源版本控制方法页面了解更多关于我们关于文档版本控制的理念。 |
tags键
tags
键是可选的,可以直接在content
键或url
键上指定。它接受一个标签名称模式列表。每个值可以是精确的标签名称(例如,v2.3.1
,v3.9.4
等)或模式(例如,v2.*
,v@({1..9})*({0..9}).+({0..9}).x
等)。标签列表也可以是这些值类型的组合。
示例1. antora-playbook.yml
content:
sources:
- url: https://git-service.com/org/repo-z.git
tags: [90.0, 93.0] (1)
- url: https://git-service.com/org/repo-x.git
tags: [95.0, releases/*, '!v1.*'] (2)
branches: ~ (3)
1 | 将多个值括在方括号中([] )。用逗号(, )分隔每个值。 |
2 | 可以将精确的标签名称和通配符模式分配给tags 键。 |
3 | 通过设置branches 并将其分配为波浪线(~ )值来禁用默认分支过滤器。 |
设置tags 键不会自动禁用默认分支过滤器! |
这些值模式不区分大小写。这意味着字符匹配不考虑大小写。这些值可以作为逗号分隔的列表指定,也可以作为单独行上的单个项目。
添加默认标签过滤器
tags
键默认情况下不使用(不像branches
键及其默认过滤器)。要将相同的标签过滤器应用于所有未明确声明tags
键的url
条目,直接在content
键上指定一个tags
键。
示例2. 分配默认标签过滤器
content:
tags: v* (1)
branches: ~ (2)
sources:
- url: https://git-service.com/org/repo-z.git (3)
- url: https://git-service.com/org/repo-x.git
tags: [v*, '!v1.*'] (4)
- url: https://git-service.com/org/repo-y.git (5)
1 | 在content 键下指定tags 以创建默认标签过滤器。 |
2 | 在所有url 键上禁用默认分支过滤器。 |
3 | 此url 将使用默认标签过滤器。 |
4 | 分配给此tags 键的值将应用于指定的url ,覆盖默认标签过滤器。 |
5 | 此url 将使用默认标签过滤器。 |
通过创建默认标签过滤器,Antora现在将发现并使用以字母v
开头的标签,用于所有未明确声明tags
键的内容源。
使用来自同一存储库的标签和分支
在此示例中,我们将加载内容存储库的main
分支以及以字母v
开头的标签。
content:
sources:
- url: https://git-service.com/org/repo-x.git
branches: [main, sneaky-chinchilla]
tags: v*
有关使用通配符(*
)的详细信息,请参阅通配符。Antora还支持使用排除、大括号、交替、范围和重复模式来匹配标签名称。请参阅内容源中的Refname匹配。