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
Copy file name to clipboardExpand all lines: docs/cli/changelog/cmd-render.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,14 @@ The `render` command automatically discovers and merges `.amend-*.yaml` files wi
9
9
10
10
The `changelog render` command does **not** use `rules.publish` for filtering. Filtering must be done at bundle time using `rules.bundle`. For how the directive differs, see the [{changelog} directive syntax reference](/syntax/changelog.md).
11
11
12
+
## Options
13
+
14
+
: `--dropdowns`
15
+
Render separated types (breaking changes, deprecations, known issues, highlights) as MyST dropdowns. Defaults to false (flattened bulleted lists). When used, each entry in separated files is rendered as a collapsible dropdown section using MyST syntax (`::::{dropdown}`). When it's not used, entries are rendered as flattened bulleted lists with PR/issue links inline and `Impact` and `Action` sections indented. This flag affects only markdown output; AsciiDoc output always uses its standard format.
16
+
17
+
: `--title`
18
+
The title to use for section headers, directories, and anchors in output files. Defaults to the version in the first bundle. When omitted, ISO date targets are formatted for display the same way as the `{changelog}` directive (for example, `2026-05-04` becomes "May 4, 2026", `2026-05` becomes "May 2026"), while directory names and heading anchors continue to use the raw target slug. If the string contains spaces, they are replaced with dashes when used in directory names and anchors.
`--file-type asciidoc` generates a single file with all sections in order: security updates, bug fixes, highlights, new features and enhancements, breaking changes, deprecations, known issues, documentation, regressions, and other changes. The asciidoc output uses attribute references for links (for example, `{repo-pull}NUMBER[#NUMBER]`).
34
+
When `--file-type asciidoc` is specified, the command generates a single asciidoc file with all sections:
35
+
36
+
- Security updates
37
+
- Bug fixes
38
+
- Highlights (only included when at least one entry has `highlight: true`)
39
+
- New features and enhancements
40
+
- Breaking changes
41
+
- Deprecations
42
+
- Known issues
43
+
- Documentation
44
+
- Regressions
45
+
- Other changes
46
+
47
+
The asciidoc output uses attribute references for links (for example, `{repo-pull}NUMBER[#NUMBER]`).
48
+
49
+
AsciiDoc output ignores the `--dropdowns` flag and always uses a standardized format with the following characteristics:
50
+
51
+
- Multi-block entries (containing description, Impact, and Action sections) use proper list continuation markers (`+`) to maintain list structure
52
+
- Strong text formatting uses idiomatic single asterisk syntax (`*Impact:*`, `*Action:*`) following AsciiDoc best practices
53
+
- All content blocks are properly attached to their parent list items for correct rendering.
0 commit comments