标识预发布版本

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

prerelease键

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

TIP: 要了解有关预发布键提供的功能的更多信息，并将其与其他版本面(实际版本、显示版本和符号版本)进行比较，请参阅版本面。

为预发布分配一个标识符

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

Example 1. Example 1. antora.yml with prerelease assigned the identifier -rc.3

name: colorado
title: Colorado ∆
version: '6.0.0'
prerelease: -rc.3 (1)

1	为预发布(prerelease)分配一个标识符，以将组件版本指定为预发布。

当 prerelease 被分配一个标识符时，Antora 计算一个内部的预发布版本值，用于 UI 排序，如果没有设置显示版本(display_version)，则用于显示目的。这个计算的预发布版本依赖于预发布标识符中的第一个字符。

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

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

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

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

Example 2. Example 2. antora.yml with prerelease assigned the identifier Beta

name: colorado
title: Colorado ∆
version: '4.0'
prerelease: Beta

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

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

将预发布赋值为true

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

Example 3. Example 3. antora.yml with prerelease defined as true

name: colorado
title: Colorado ∆
version: '6.5.0-snapshot'
prerelease: true

当 prerelease 为 true 时，组件版本按照 version 的值排序，但默认路由规则不会应用于它，即使它是该文档组件中的最新版本。

预发布排序和路由

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

将预发布版提升到稳定版

当组件版本准备好从预发布升级到稳定发布时，将预发布键(prerelease)的值更改为 false 。

Example 4. Example 4. antora.yml with prerelease defined as false

name: colorado
title: Colorado ∆
version: '6.0.0'
prerelease: false (1)

1	删除之前的值，并将其替换为 `false` ，以将组件版本提升到稳定版本。

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