Render missing changelog types and subtypes #2427
Merged
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 augments #2341
Summary
docs-builder changelog rendercommand.docs-builder changelog rendercommand to group breaking changes bysubtypewhen--subsectionsis used and the entry has a subtype.Examples
./build.sh clean ./build.sh publishbinaries cd .artifacts/publish/docs-builder/release./docs-builder changelog bundle --all --directory ./test-1 \ --output-products "elasticsearch 1.2.3" \ --output ./bundles/changelog-bundle-es.yml \ --resolve./docs-builder changelog render \ --input "./bundles/changelog-bundle-es.yml,,elasticsearch" \ --output ./out-es./docs-builder changelog render \ --input "./bundles/changelog-bundle-es.yml,,elasticsearch" \ --output ./out-es-sections \ --subsectionsThe new known issues page looks like this:
With
--subsections, groupings look like this:Changes Made
ChangelogEntryTypes:RenderKnownIssuesMarkdownmethod:RenderBreakingChangesMarkdownandRenderDeprecationsMarkdownknown-issues.mdfileRenderIndexMarkdownmethod:docs,regression, andothertypes[Known issues](/release-notes/known-issues.md#{repo}-{titleSlug}-known-issues)(matching breaking changes and deprecations)RenderKnownIssuesMarkdownin theRenderChangelogsmethodRenderBreakingChangesMarkdown--subsectionsis true, groups breaking changes by subtype instead of area--subsectionsis false, keeps the existing behavior (group by area)RenderDeprecationsMarkdown— Same conditional logicRenderKnownIssuesMarkdown— Same conditional logicFormatSubtypeHeadermethod:--subsectionsparameter description inChangelogCommand.csto mention that breaking changes with subtypes are grouped by subtypedocs/contribute/changelog.mdto document that breaking changes with subtypes are grouped by subtype when--subsectionsis usedBehaviour
known-issueentries generate a separateknown-issues.mdpage with optional "impact" and "action" content (like breaking changes and deprecations)docs,regression, andotherentries are rendered as sections withinindex.mdfeature,enhancement,bug-fix,security→ sections inindex.mddocs,regression,other→ sections inindex.mdknown-issue→ separateknown-issues.mdpagebreaking-change→ separatebreaking-changes.mdpage (already existed)deprecation→ separatedeprecations.mdpage (already existed)When
--subsectionsis used:When
--subsectionsis not used, all entries render without subsections (existing behavior).The build completed successfully with no errors.
The implementation:
Generative AI disclosure
Tool(s) and model(s) used: composer-1 agent