Fix changelog render when title has spaces#2409
Merged
lcawl merged 1 commit intochangelog-manifestfrom Dec 31, 2025
Merged
Conversation
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 fixes a problem that was encountered in https://github.com/elastic/cloud/pull/150210 where the
docs-builder changelog render --title "November 2025"option made for poor folder names and poor anchors in the output files.Summary
Updated the
docs-builder changelog rendercommand to format the--titleoption for folder names and anchors.All existing tests pass.
Changes made
TitleToSlughelper method (ChangelogService.cs):RenderChangelogsmethod:titleSlugfrom the titletitle(display) andtitleSlug(URL-friendly) to render methodsRenderIndexMarkdown: Uses slug for folder names and anchors, original title for headersRenderBreakingChangesMarkdown: Uses slug for folder names and anchors, original title for headersRenderDeprecationsMarkdown: Uses slug for folder names and anchors, original title for headersUsage
When the
docs-builder changelog rendercommand has--title "November 30 2025", the output hasnovember-30-2025/[elastic-release-notes-november-30-2025]## November 30 2025(unchanged)Generative AI disclosure
Tool(s) and model(s) used: composer-1 agent