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
The `packages` field uses keys that map to display names in `global.yml` under `display_names`.
243
246
244
247
### Release Notes Generation
245
248
246
-
Release notes are automatically generated for images that have all required fields (`announcement` and `packages`).
249
+
Release notes are automatically generated for images that have all required fields (`announcements` and `packages`).
247
250
248
251
**Output structure:**
249
252
@@ -275,7 +278,7 @@ This separation uses the `ImageConfig.is_supported` property.
275
278
276
279
**Generated release note sections:**
277
280
278
-
1. **Announcement** - Bullet list from `announcement` field
281
+
1. **Announcements** - Bullet list from `announcements` field
279
282
1. **Core Packages** - Table from `packages` field (keys mapped via `display_names`)
280
283
1. **Security Advisory** - Hardcoded section with link to AWS Security Bulletin
281
284
1. **Reference** - Docker image URIs (private ECR + public ECR if `public_registry: true`) and links to available_images.md and support_policy.md
@@ -357,11 +360,16 @@ table_order:
357
360
358
361
The `framework_groups` configuration consolidates support policy rows by framework. Repositories in the same group are combined into a single row using the framework name (e.g., "PyTorch").
359
362
363
+
**Version Display:**
364
+
365
+
- Images with the same major.minor version (e.g., `2.6.0` and `2.6.1`) are consolidated into a single row displayed as `2.6` if they have identical GA/EOP dates
366
+
- If patch versions have different GA/EOP dates, each is displayed separately with full version (e.g., `2.6.0`, `2.6.1`) and a warning is logged
367
+
360
368
**Requirements:**
361
369
362
-
- All repositories in a group that have a given version must have identical GA/EOP dates
370
+
- All repositories in a group that have a given full version (X.Y.Z) must have identical GA/EOP dates
363
371
- Missing versions in some repositories are allowed (only present repos are consolidated)
364
-
- A `ValueError` is raised if dates differ within a group for the same version
372
+
- A `ValueError` is raised if dates differ within a group for the same full version
365
373
366
374
To add a new framework group, add an entry to `framework_groups` with the framework name as key and list of repositories as value.
The YAML file name is for organizational purposes only. However, make sure that the image configuration file lives in the correct repository directory.
70
+
69
71
See `docs/src/data/template/image-template.yml` for all available fields.
70
72
71
73
### Step 2: Regenerate
@@ -85,7 +87,12 @@ ga: "2025-10-15" # General Availability date
85
87
eop: "2026-10-15" # End of Patch date
86
88
```
87
89
88
-
**Validation:** All images in the same framework group with the same version must have identical GA/EOP dates.
90
+
**Version Consolidation:**
91
+
92
+
- Images with the same major.minor version (e.g., `2.6.0` and `2.6.1`) are consolidated into a single row displayed as `2.6` if they have identical GA/EOP dates
93
+
- If patch versions have different GA/EOP dates, each is displayed separately with full version (e.g., `2.6.0`, `2.6.1`) and a warning is logged
94
+
95
+
**Validation:** All images in the same framework group with the same full version (X.Y.Z) must have identical GA/EOP dates.
To add additional fields, ensure that the image configuration YAML file contains said field of the same name.
191
+
Additionally, if you require the field to be formatted, add an additional attribute in `ImageConfig` class of `display_<field_name>` to grab the formatted field.
0 commit comments