Skip to content

Fix changelog render when title has spaces #2409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcawl merged 1 commit into from
Dec 31, 2025
+27 −13
Merged

Fix changelog render when title has spaces #2409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions src/services/Elastic.Documentation.Services/ChangelogService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1349,18 +1349,20 @@ Cancel ctx

// Use title from input or default to version
var title = input.Title ?? version;
// Convert title to slug format for folder names and anchors (lowercase, dashes instead of spaces)
var titleSlug = TitleToSlug(title);

// Render markdown files (use first repo found, or default)
var repoForRendering = allResolvedEntries.Count > 0 ? allResolvedEntries[0].repo : defaultRepo;

// Render index.md (features, enhancements, bug fixes, security)
await RenderIndexMarkdown(collector, outputDir, title, repoForRendering, allResolvedEntries.Select(e => e.entry).ToList(), entriesByType, input.Subsections, input.HidePrivateLinks, ctx);
await RenderIndexMarkdown(collector, outputDir, title, titleSlug, repoForRendering, allResolvedEntries.Select(e => e.entry).ToList(), entriesByType, input.Subsections, input.HidePrivateLinks, ctx);

// Render breaking-changes.md
await RenderBreakingChangesMarkdown(collector, outputDir, title, repoForRendering, allResolvedEntries.Select(e => e.entry).ToList(), entriesByType, input.Subsections, input.HidePrivateLinks, ctx);
await RenderBreakingChangesMarkdown(collector, outputDir, title, titleSlug, repoForRendering, allResolvedEntries.Select(e => e.entry).ToList(), entriesByType, input.Subsections, input.HidePrivateLinks, ctx);

// Render deprecations.md
await RenderDeprecationsMarkdown(collector, outputDir, title, repoForRendering, allResolvedEntries.Select(e => e.entry).ToList(), entriesByType, input.Subsections, input.HidePrivateLinks, ctx);
await RenderDeprecationsMarkdown(collector, outputDir, title, titleSlug, repoForRendering, allResolvedEntries.Select(e => e.entry).ToList(), entriesByType, input.Subsections, input.HidePrivateLinks, ctx);

_logger.LogInformation("Rendered changelog markdown files to {OutputDir}", outputDir);

Expand Down Expand Up @@ -1393,6 +1395,7 @@ private async Task RenderIndexMarkdown(
IDiagnosticsCollector collector,
string outputDir,
string title,
string titleSlug,
string repo,
List<ChangelogData> entries,
Dictionary<string, List<ChangelogData>> entriesByType,
Expand Down Expand Up @@ -1422,15 +1425,15 @@ Cancel ctx
}
if (hasBreakingChanges)
{
otherLinks.Add($"[Breaking changes](/release-notes/breaking-changes.md#{repo}-{title}-breaking-changes)");
otherLinks.Add($"[Breaking changes](/release-notes/breaking-changes.md#{repo}-{titleSlug}-breaking-changes)");
}
if (hasDeprecations)
{
otherLinks.Add($"[Deprecations](/release-notes/deprecations.md#{repo}-{title}-deprecations)");
otherLinks.Add($"[Deprecations](/release-notes/deprecations.md#{repo}-{titleSlug}-deprecations)");
}

var sb = new StringBuilder();
sb.AppendLine(CultureInfo.InvariantCulture, $"## {title} [{repo}-release-notes-{title}]");
sb.AppendLine(CultureInfo.InvariantCulture, $"## {title} [{repo}-release-notes-{titleSlug}]");

if (otherLinks.Count > 0)
{
Expand All @@ -1443,15 +1446,15 @@ Cancel ctx
{
if (features.Count > 0 || enhancements.Count > 0)
{
sb.AppendLine(CultureInfo.InvariantCulture, $"### Features and enhancements [{repo}-{title}-features-enhancements]");
sb.AppendLine(CultureInfo.InvariantCulture, $"### Features and enhancements [{repo}-{titleSlug}-features-enhancements]");
var combined = features.Concat(enhancements).ToList();
RenderEntriesByArea(sb, combined, repo, subsections, hidePrivateLinks);
}

if (security.Count > 0 || bugFixes.Count > 0)
{
sb.AppendLine();
sb.AppendLine(CultureInfo.InvariantCulture, $"### Fixes [{repo}-{title}-fixes]");
sb.AppendLine(CultureInfo.InvariantCulture, $"### Fixes [{repo}-{titleSlug}-fixes]");
var combined = security.Concat(bugFixes).ToList();
RenderEntriesByArea(sb, combined, repo, subsections, hidePrivateLinks);
}
Expand All @@ -1461,7 +1464,7 @@ Cancel ctx
sb.AppendLine("_No new features, enhancements, or fixes._");
}

var indexPath = _fileSystem.Path.Combine(outputDir, title, "index.md");
var indexPath = _fileSystem.Path.Combine(outputDir, titleSlug, "index.md");
var indexDir = _fileSystem.Path.GetDirectoryName(indexPath);
if (!string.IsNullOrWhiteSpace(indexDir) && !_fileSystem.Directory.Exists(indexDir))
{
Expand All @@ -1477,6 +1480,7 @@ private async Task RenderBreakingChangesMarkdown(
IDiagnosticsCollector collector,
string outputDir,
string title,
string titleSlug,
string repo,
List<ChangelogData> entries,
Dictionary<string, List<ChangelogData>> entriesByType,
Expand All @@ -1488,7 +1492,7 @@ Cancel ctx
var breakingChanges = entriesByType.GetValueOrDefault("breaking-change", []);

var sb = new StringBuilder();
sb.AppendLine(CultureInfo.InvariantCulture, $"## {title} [{repo}-{title}-breaking-changes]");
sb.AppendLine(CultureInfo.InvariantCulture, $"## {title} [{repo}-{titleSlug}-breaking-changes]");

if (breakingChanges.Count > 0)
{
Expand Down Expand Up @@ -1572,7 +1576,7 @@ Cancel ctx
sb.AppendLine("_No breaking changes._");
}

var breakingPath = _fileSystem.Path.Combine(outputDir, title, "breaking-changes.md");
var breakingPath = _fileSystem.Path.Combine(outputDir, titleSlug, "breaking-changes.md");
var breakingDir = _fileSystem.Path.GetDirectoryName(breakingPath);
if (!string.IsNullOrWhiteSpace(breakingDir) && !_fileSystem.Directory.Exists(breakingDir))
{
Expand All @@ -1588,6 +1592,7 @@ private async Task RenderDeprecationsMarkdown(
IDiagnosticsCollector collector,
string outputDir,
string title,
string titleSlug,
string repo,
List<ChangelogData> entries,
Dictionary<string, List<ChangelogData>> entriesByType,
Expand All @@ -1599,7 +1604,7 @@ Cancel ctx
var deprecations = entriesByType.GetValueOrDefault("deprecation", []);

var sb = new StringBuilder();
sb.AppendLine(CultureInfo.InvariantCulture, $"## {title} [{repo}-{title}-deprecations]");
sb.AppendLine(CultureInfo.InvariantCulture, $"## {title} [{repo}-{titleSlug}-deprecations]");

if (deprecations.Count > 0)
{
Expand Down Expand Up @@ -1683,7 +1688,7 @@ Cancel ctx
sb.AppendLine("_No deprecations._");
}

var deprecationsPath = _fileSystem.Path.Combine(outputDir, title, "deprecations.md");
var deprecationsPath = _fileSystem.Path.Combine(outputDir, titleSlug, "deprecations.md");
var deprecationsDir = _fileSystem.Path.GetDirectoryName(deprecationsPath);
if (!string.IsNullOrWhiteSpace(deprecationsDir) && !_fileSystem.Directory.Exists(deprecationsDir))
{
Expand Down Expand Up @@ -1816,6 +1821,15 @@ private static string Beautify(string text)
return result;
}

private static string TitleToSlug(string title)
{
if (string.IsNullOrWhiteSpace(title))
return string.Empty;

// Convert to lowercase and replace spaces with dashes
return title.ToLowerInvariant().Replace(' ', '-');
}

private static string Indent(string text)
{
// Indent each line with two spaces
Expand Down
Loading