Skip to content

Commit 0845721

Browse files
committed
Reconcile render docs
1 parent 28063df commit 0845721

2 files changed

Lines changed: 42 additions & 214 deletions

File tree

docs/cli/changelog/cmd-render.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,33 @@ The default output (`--file-type markdown`) generates multiple files:
2525

2626
`--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]`).
2727

28+
### GFM format
29+
30+
When `--file-type gfm` is specified, the command generates a single GitHub Flavored Markdown file optimized for GitHub releases:
31+
32+
- `changelog.md` - Contains all sections in a single file with clean headings
33+
- Clean section headings without anchor links (for example, `### Features and enhancements`)
34+
- Simplified structure focused on readability
35+
- Suitable for copy/pasting into GitHub releases
36+
37+
The GFM output includes the following sections in order when entries are present:
38+
39+
- Highlights (only included when at least one entry has `highlight: true`)
40+
- Features and enhancements
41+
- Breaking changes
42+
- Deprecations
43+
- Bug fixes (includes security updates)
44+
- Known issues
45+
- Documentation
46+
- Regressions
47+
- Other changes
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
54+
2855
### Multiple PR and issue links
2956

3057
Changelog entries can reference multiple pull requests and issues via the `prs` and `issues` array fields. All links are rendered inline:
@@ -36,10 +63,11 @@ Changelog entries can reference multiple pull requests and issues via the `prs`
3663
## Examples
3764

3865
```sh
39-
# Render a single bundle
66+
# Render a single bundle with subsections
4067
docs-builder changelog render \
4168
--input "./docs/changelog/bundles/9.3.0.yaml" \
42-
--output ./release-notes
69+
--output ./release-notes \
70+
--subsections
4371

4472
# Render with explicit changelog dir and repo
4573
docs-builder changelog render \
@@ -55,4 +83,16 @@ docs-builder changelog render \
5583
docs-builder changelog render \
5684
--input "./public-bundle.yaml|./changelog|elasticsearch|keep-links,./private-bundle.yaml|./private-changelog|internal-repo|hide-links" \
5785
--output ./release-notes
86+
87+
# Render with dropdown format
88+
docs-builder changelog render \
89+
--input "./bundles/9.3.0.yaml|./changelog|elasticsearch" \
90+
--output ./release-notes \
91+
--dropdowns
92+
93+
# Render as GitHub Flavored Markdown
94+
docs-builder changelog render \
95+
--input "./bundles/9.3.0.yaml|./changelog|elasticsearch" \
96+
--output ./github-release \
97+
--file-type gfm
5898
```

docs/cli/changelog/render.md

Lines changed: 0 additions & 212 deletions
This file was deleted.

0 commit comments

Comments
 (0)