Add changelog render --no-descriptions#3263
Open
lcawl wants to merge 4 commits into
Open
Conversation
2 tasks
Base automatically changed from
changelog-render-asciidoc
to
changelog-render-dropdowns
May 7, 2026 15:27
f39fbb4 to
159ef98
Compare
159ef98 to
f5fbfc9
Compare
10 tasks
fdea239 to
0845721
Compare
0845721 to
e4b6e4e
Compare
b8d31e3 to
0691b11
Compare
e4b6e4e to
14f2d26
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR enhances the "changelog render" command with a
--no-descriptionsoption similar to what was accomplished in changelog directives via #3224In this case, however, we've omitted the
autobehavior to keep it simple.NOTE: This PR also incorporates #3272, since I figured it was dependent on this one.
Screenshots
Before
In #3262, asciidoc output:
Descriptions in breaking changes and deprecations:

Descriptions in fixes and enhancements:

After
Asciidoc output:
Descriptions omitted from breaking changes and descriptions:

Descriptions omitted from fixes and enhancements:

AI summary
The implementation works with both
--file-type markdownand--file-type asciidoc, hiding entry descriptions while preserving all other content (titles, links, Impact/Action sections, bundle descriptions).1. CLI Parameter & Arguments
bool noDescriptions = falseparameter toChangelogCommand.RenderHideDescriptionsproperty toRenderChangelogsArguments2. Render Context
HideDescriptionsproperty toChangelogRenderContextBuildRenderContextto pass through the flag3. All Renderers Updated
Markdown Renderers (
--file-type markdown):IndexMarkdownRenderer- gates description in bulleted listsBreakingChangesMarkdownRenderer- gates description in both dropdown and flattened modesDeprecationsMarkdownRenderer- gates description in both modesKnownIssuesMarkdownRenderer- gates description in both modesHighlightsMarkdownRenderer- gates description in both modesAsciiDoc Renderers (
--file-type asciidoc):AsciidocRendererBase.RenderEntryDescription()- updated to return early whencontext.HideDescriptionsis true4. Comprehensive Tests
tests/Elastic.Changelog.Tests/Changelogs/Render/DescriptionVisibilityTests.cs5. Documentation
docs/cli/changelog/render.mdwith--no-descriptionsflag documentationGenerative AI disclosure
Tool(s) and model(s) used: composer-2, claude-4-sonnet-thinking