Improve changelog render for asciidoc#3262
Merged
cotti merged 2 commits intochangelog-render-dropdownsfrom May 7, 2026
Merged
Conversation
This was referenced May 7, 2026
cotti
approved these changes
May 7, 2026
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 builds on #3244 (and addresses #3244 (comment)).
It fixes formatting issues that were apparent while testing the
docs-builder changelog rendercommand with--format-type asciidoc. For example:+continuation syntaxScreenshots
Before
Lists with paragraphs and no

--subsectionsaren't aligned well and inject an unexpected "general" area:Lists with paragraphs and

--subsectionsare smushed together in definition listsAfter
Lists with paragraphs and no

--subsectionswork:Lists with paragraphs and

--subsectionswork by moving away from fragile definition lists:NOTE: Since there are teams who have already said they don't want the descriptions published, I've created #3263 as a follow-on too.
AI Summary
Improves
changelog renderAsciiDoc output for multi-block list items (description, Impact, Action), aligns Markdown PR/issue link rendering with analyzer-friendly options, fixes AsciiDoc subsection behavior versus--subsections, replaces definition lists with nested sections where grouping is intended, and documents AsciiDoc behavior in the CLI reference.AsciiDoc
AsciidocRendererBase+) before description text (when continuation applies) and before Impact/Action blocks so bullets stay attached to the list item.//per line).*Impact:*/*Action:*instead of**Impact:**/**Action:**.975b4200)Subsections; when--subsectionsis off, collapse to a single group without aGeneral-style wrapper.--subsectionsis on, replaceComponent::definition lists with[float]+==== Titlenested sections (and commented-out equivalents when all entries in the group are hidden).// [float]/// ==== ….AppendLine(CultureInfo.InvariantCulture, …)where applicable (per second commit diff).Markdown
PrIssueLinkOptionsand a singleRenderPrIssueLinks(StringBuilder, PrIssueLinkOptions)API (avoids long parameter lists / adjacent booleans).Docs & tests
docs/cli/changelog/render.md: clarifies that AsciiDoc ignores--dropdowns, and briefly describes list continuation,*Impact:*/*Action:*, and attachment of blocks to list items.DropdownRenderTests: AsciiDoc expectations updated for*Impact:*/*Action:*.Generative AI disclosure
Tool(s) and model(s) used: composer-2, claude-4-sonnet-thinking