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
`--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]`).
27
27
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
+
28
55
### Multiple PR and issue links
29
56
30
57
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`
0 commit comments