You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Regardless of the version format used in the source file, the version number is always rendered in the `Major.Minor.Patch` format.
7
+
**Version Display:**
8
+
9
+
- Versions are always displayed as **Major.Minor** (e.g., `9.1`) in badges, regardless of the format used in source files.
10
+
- Each version represents the **latest patch** of that minor version (e.g., `9.1` means 9.1.0, 9.1.1, 9.1.6, etc.).
11
+
- The `+` symbol indicates "this version and later" (e.g., `9.1+` means 9.1.0 and all subsequent releases).
12
+
- Ranges show both versions (e.g., `9.0-9.2`) when both are released, or convert to `+` format if the end version is unreleased.
7
13
8
14
:::{note}
9
-
**Automatic Version Sorting**: When you specify multiple versions for the same product, the build system automatically sorts them in descending order (highest version first) regardless of the order you write them in the source file. For example, `stack: ga 8.18.6, ga 9.1.2, ga 8.19.2, ga 9.0.6` will be displayed as `stack: ga 9.1.2, ga 9.0.6, ga 8.19.2, ga 8.18.6`. Items without versions (like `ga` without a version or `all`) are sorted last.
15
+
**Automatic Version Sorting**: When you specify multiple versions for the same product, the build system automatically sorts them in descending order (highest version first) regardless of the order you write them in the source file. For example, `stack: ga 9.1, beta 9.0, preview 8.18` will be displayed with the highest priority lifecycle and version first. Items without versions are sorted last.
\* Range display depends on release status of the second version.
43
+
44
+
**Important notes:**
45
+
46
+
- Versions are always displayed as **Major.Minor** (e.g., `9.1`) in badges, regardless of whether you specify patch versions in the source.
47
+
- Each version statement corresponds to the **latest patch** of the specified minor version (e.g., `9.1` represents 9.1.0, 9.1.1, 9.1.6, etc.).
48
+
- When critical patch-level differences exist, use plain text descriptions alongside the badge rather than specifying patch versions.
49
+
50
+
### Version Validation Rules
51
+
52
+
The build process enforces the following validation rules:
53
+
54
+
-**One version per lifecycle**: Each lifecycle (GA, Preview, Beta, etc.) can only have one version declaration.
55
+
- ✅ `stack: ga 9.2+, beta 9.0-9.1`
56
+
- ❌ `stack: ga 9.2, ga 9.3`
57
+
-**One "greater than" per key**: Only one lifecycle per product key can use the `+` (greater than or equal to) syntax.
58
+
- ✅ `stack: ga 9.2+, beta 9.0-9.1`
59
+
- ❌ `stack: ga 9.2+, beta 9.0+`
60
+
-**Valid range order**: In ranges, the first version must be less than or equal to the second version.
61
+
- ✅ `stack: preview 9.0-9.2`
62
+
- ❌ `stack: preview 9.2-9.0`
63
+
-**No version overlaps**: Versions for the same key cannot overlap (ranges are inclusive).
64
+
- ✅ `stack: ga 9.2+, beta 9.0-9.1`
65
+
- ❌ `stack: ga 9.2+, beta 9.0-9.2`
66
+
32
67
### Page level
33
68
34
69
Page level annotations are added in the YAML frontmatter, starting with the `applies_to` key and following the [key-value reference](#key-value-reference). For example:
@@ -134,6 +169,22 @@ Use the following key-value reference to find the appropriate key and value for
134
169
135
170
## Examples
136
171
172
+
### Version Syntax Examples
173
+
174
+
The following table demonstrates the various version syntax options and their rendered output:
0 commit comments