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
--description "Elasticsearch {version} includes performance improvements. Download: https://github.com/{owner}/{repo}/releases/tag/v{version}"
389
389
```
390
390
391
+
### Bundle with release date
392
+
393
+
You can add a `release-date` field directly to a bundle YAML file. This field is optional and purely informative for end-users. It is especially useful for components released outside the usual stack lifecycle, such as APM agents and EDOT agents.
394
+
395
+
```yaml
396
+
products:
397
+
- product: apm-agent-dotnet
398
+
target: 1.34.0
399
+
release-date: "April 9, 2026"
400
+
description: |
401
+
This release includes tracing improvements and bug fixes.
402
+
entries:
403
+
- file:
404
+
name: tracing-improvement.yaml
405
+
checksum: abc123
406
+
```
407
+
408
+
When the bundle is rendered (by the `changelog render` command or `{changelog}` directive), the release date appears immediately after the version heading as italicized text: `_Released: April 9, 2026_`.
409
+
391
410
## Profile-based examples
392
411
393
412
When the changelog configuration file defines `bundle.profiles`, you can use those profiles with the `changelog bundle` command.
Copy file name to clipboardExpand all lines: docs/syntax/changelog.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,10 +142,11 @@ For full syntax, refer to the [rules for filtered bundles](/cli/changelog/bundle
142
142
When bundles contain a `hide-features` field, entries with matching `feature-id` values are automatically filtered out from the rendered output. This allows you to hide unreleased or experimental features without modifying the bundle at render time.
143
143
144
144
```yaml
145
-
# Example bundle with description and hide-features
145
+
# Example bundle with release-date, description, and hide-features
146
146
products:
147
147
- product: elasticsearch
148
148
target: 9.3.0
149
+
release-date: "2026-04-09"
149
150
description: |
150
151
This release includes new features and bug fixes.
151
152
@@ -227,11 +228,13 @@ The version is extracted from the first product's `target` field in each bundle
227
228
228
229
## Rendered output
229
230
230
-
Each bundle renders as a `## {version}` section with optional description and subsections beneath:
231
+
Each bundle renders as a `## {version}` section with optional release date, description, and subsections beneath:
231
232
232
233
```markdown
233
234
## 0.100.0
234
235
236
+
_Released: 2026-04-09_
237
+
235
238
This release includes new features and bug fixes.
236
239
237
240
Download the release binaries: https://github.com/elastic/elasticsearch/releases/tag/v0.100.0
@@ -246,7 +249,9 @@ Download the release binaries: https://github.com/elastic/elasticsearch/releases
246
249
...
247
250
```
248
251
249
-
Bundle descriptions are rendered when present in the bundle YAML file. The description appears immediately after the version heading but before any entry sections. Descriptions support Markdown formatting including links, lists, and multiple paragraphs.
252
+
When present, the `release-date` field is rendered immediately after the version heading as italicized text (e.g., `_Released: 2026-04-09_`). This is purely informative for end-users and is especially useful for components released outside the usual stack lifecycle, such as APM agents and EDOT agents.
253
+
254
+
Bundle descriptions are rendered when present in the bundle YAML file. The description appears after the release date (if any) but before any entry sections. Descriptions support Markdown formatting including links, lists, and multiple paragraphs.
0 commit comments