Skip to content

Add changelog render --no-descriptions#3263

Open
lcawl wants to merge 1 commit intochangelog-render-dropdownsfrom
changelog-render-no-descriptions
Open

Add changelog render --no-descriptions#3263
lcawl wants to merge 1 commit intochangelog-render-dropdownsfrom
changelog-render-no-descriptions

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented May 7, 2026

This PR enhances the "changelog render" command with a --no-descriptions option similar to what was accomplished in changelog directives via #3224
In this case, however, we've omitted the auto behavior to keep it simple.

Screenshots

Before

In #3262, asciidoc output:

  • Descriptions in breaking changes and deprecations:
    image

  • Descriptions in fixes and enhancements:
    image

After

Asciidoc output:

  • Descriptions omitted from breaking changes and descriptions:
    image

  • Descriptions omitted from fixes and enhancements:
    image

AI summary

The implementation works with both --file-type markdown and --file-type asciidoc, hiding entry descriptions while preserving all other content (titles, links, Impact/Action sections, bundle descriptions).

1. CLI Parameter & Arguments

  • Added bool noDescriptions = false parameter to ChangelogCommand.Render
  • Added HideDescriptions property to RenderChangelogsArguments
  • Updated parameter documentation

2. Render Context

  • Added HideDescriptions property to ChangelogRenderContext
  • Updated BuildRenderContext to pass through the flag

3. All Renderers Updated

Markdown Renderers (--file-type markdown):

  • IndexMarkdownRenderer - gates description in bulleted lists
  • BreakingChangesMarkdownRenderer - gates description in both dropdown and flattened modes
  • DeprecationsMarkdownRenderer - gates description in both modes
  • KnownIssuesMarkdownRenderer - gates description in both modes
  • HighlightsMarkdownRenderer - gates description in both modes

AsciiDoc Renderers (--file-type asciidoc):

  • AsciidocRendererBase.RenderEntryDescription() - updated to return early when context.HideDescriptions is true
  • This automatically affects all concrete AsciiDoc renderers

4. Comprehensive Tests

  • ✅ Created tests/Elastic.Changelog.Tests/Changelogs/Render/DescriptionVisibilityTests.cs
  • Tests cover both markdown and asciidoc formats
  • Tests verify descriptions are hidden while preserving titles, links, Impact/Action
  • Tests cover both dropdown and flattened modes
  • Tests verify bundle descriptions remain visible

5. Documentation

  • ✅ Updated docs/cli/changelog/render.md with --no-descriptions flag documentation

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: composer-2, claude-4-sonnet-thinking

@lcawl lcawl mentioned this pull request May 7, 2026
2 tasks
Base automatically changed from changelog-render-asciidoc to changelog-render-dropdowns May 7, 2026 15:27
@lcawl lcawl force-pushed the changelog-render-no-descriptions branch from f39fbb4 to 159ef98 Compare May 7, 2026 17:22
@lcawl lcawl force-pushed the changelog-render-no-descriptions branch from 159ef98 to f5fbfc9 Compare May 7, 2026 17:27
@lcawl lcawl marked this pull request as ready for review May 7, 2026 17:27
@lcawl lcawl requested review from a team as code owners May 7, 2026 17:27
@lcawl lcawl requested a review from Mpdreamz May 7, 2026 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant