识别预发布版本

prerelease键将组件版本标识为预发布版本。

预发布键

prerelease键是可选的。当prerelease键被分配用户定义的标识符(例如-beta.2)或布尔值true时,组件版本被标识为预发布版本。即使它是该文档组件中的最新版本(除非所有版本都是预发布版本),Antora也不会对被指定为预发布版本的组件版本应用默认路由规则。当组件版本准备从预发布版本升级为稳定版本时,将prerelease键的值更改为false或从antora.yml文件中删除该键及其值。

要了解prerelease键提供的功能以及将其与其他版本特性(实际版本、显示版本和符号版本)进行比较,请参阅版本特性

为预发布分配标识符

当在antora.yml中设置prerelease键并分配标识符时,组件版本将成为预发布版本。一个标识符是一个用户定义的非空字符串,例如.alpha.2-M1SNAPSHOT-rc.5。它可以包含大写字母和各种字符。在示例1中定义的组件版本是一个预发布版本。

示例1. 带有分配标识符 -rc.3 的 antora.yml
name: colorado
title: Colorado ∆
version: '6.0.0'
prerelease: -rc.3 (1)
1 prerelease分配一个标识符,将组件版本标记为预发布版本。

当为prerelease分配标识符时,Antora会计算用于UI排序的内部预发布版本值,如果未设置display_version,则用于显示目的。这个计算的预发布版本取决于预发布标识符中的第一个字符。

以连字符(-)或点号(.)开头的标识符

计算的预发布版本采用版本-标识符版本.标识符的形式。Antora直接将预发布标识符附加到version键的值以计算预发布版本。例如,使用示例1,计算的预发布版本将是6.0.0-rc.3

以任何其他有效字符开头的标识符

计算的预发布版本采用版本 标识符的形式。Antora使用一个空格将标识符与version键的值分开以计算预发布版本。

示例2. 带有分配标识符 Beta 的 antora.yml
name: colorado
title: Colorado ∆
version: '4.0'
prerelease: Beta

使用示例2,计算的预发布版本将是4.0 Beta

除非在antora.yml中设置了display_version键,否则Antora会在运行时将计算的预发布版本分配给display_version。如果在antora.yml中定义了display_version,则该值将显示在UI中。但是,组件版本仍然会根据内部计算的预发布版本值进行排序

为预发布分配 true

当在antora.yml中设置prerelease键并将值设置为true时,组件版本将成为预发布版本。

示例3. 带有定义为 true 的 antora.yml
name: colorado
title: Colorado ∆
version: '6.5.0-snapshot'
prerelease: true

prereleasetrue时,组件版本将根据version的值进行排序,但即使它是该文档组件中的最新版本,也不会应用默认路由规则

预发布版本的排序和路由

当Antora选择文档组件的最新版本时,会跳过预发布版本,除非所有组件版本都是预发布版本,在这种情况下将应用默认规则。它们根据计算的预发布版本符合的版本方案标准进行排序。

将预发布版本升级为稳定版本

当组件版本准备从预发布版本升级为稳定版本时,将prerelease键的值更改为false

示例4. 带有定义为 false 的 antora.yml
name: colorado
title: Colorado ∆
version: '6.0.0'
prerelease: false (1)
1 删除先前的值并替换为false以将组件版本升级为稳定版本。

prerelease设置为false时,将应用默认的路由和排序规则到组件版本。或者,一旦稳定,您可以从antora.yml中删除该键及其值。