Skip to content

Ensure keys in redirect.yml get validated as relative to docset.yml #1866

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
merged 3 commits into from
Sep 10, 2025
Merged

Ensure keys in redirect.yml get validated as relative to docset.yml #1866

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8e4d17
Ensure keys in redirect.yml get validated as relative to docset.yml
Mpdreamz Sep 10, 2025
14d0480
Move from hint to warning
Mpdreamz Sep 10, 2025
df4f346
Make root relative keys an error
Mpdreamz Sep 10, 2025
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
44 changes: 23 additions & 21 deletions src/tooling/docs-builder/Cli/DiffCommands.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,31 +77,33 @@ public async Task<int> ValidateRedirects(string? path = null, Cancel ctx = defau
if (changed.Length != 0)
_log.LogInformation("Found {Count} changes to files related to documentation in the current branch.", changed.Length);

var missingRedirects = changed
.Where(c =>
c.ChangeType is GitChangeType.Deleted or GitChangeType.Renamed
&& !redirects.ContainsKey(c is RenamedGitChange renamed ? renamed.OldFilePath : c.FilePath)
)
.ToArray();

if (missingRedirects.Length != 0)
{
var relativeRedirectFile = Path.GetRelativePath(root.FullName, redirectFile.Source.FullName);
_log.LogInformation("Found {Count} changes that still require updates to: {RedirectFile}", missingRedirects.Length, relativeRedirectFile);
}

foreach (var notFound in missingRedirects)
var deletedAndRenamed = changed.Where(c => c.ChangeType is GitChangeType.Deleted or GitChangeType.Renamed).ToArray();
var missingCount = 0;
foreach (var change in deletedAndRenamed)
{
if (notFound is RenamedGitChange renamed)
var lookupPath = change is RenamedGitChange renamed ? renamed.OldFilePath : change.FilePath;
var docSetRelativePath = Path.GetRelativePath(buildContext.DocumentationSourceDirectory.FullName, Path.Combine(root.FullName, lookupPath));
var rootRelativePath = Path.GetRelativePath(root.FullName, Path.Combine(root.FullName, lookupPath));
if (redirects.ContainsKey(docSetRelativePath))
continue;
if (redirects.ContainsKey(rootRelativePath))
{
collector.EmitError(redirectFile.Source,
$"File '{renamed.OldFilePath}' was renamed to '{renamed.NewFilePath}' but it has no redirect configuration set.");
}
else if (notFound.ChangeType is GitChangeType.Deleted)
{
collector.EmitError(redirectFile.Source,
$"File '{notFound.FilePath}' was deleted but it has no redirect targets. This will lead to broken links.");
$"Redirect contains path relative to root '{rootRelativePath}' but should be relative to the documentation set '{docSetRelativePath}'");
continue;
}
missingCount++;

if (change is RenamedGitChange rename)
collector.EmitError(redirectFile.Source, $"Missing '{docSetRelativePath}' in redirects.yml. '{rename.OldFilePath}' was renamed to '{rename.NewFilePath}' but it has no redirect configuration set.");
else if (change.ChangeType is GitChangeType.Deleted)
collector.EmitError(redirectFile.Source, $"Missing '{docSetRelativePath}' in redirects.yml. '{change.FilePath}' was deleted but it has no redirect targets. This will lead to broken links.");
}

if (missingCount != 0)
{
var relativeRedirectFile = Path.GetRelativePath(root.FullName, redirectFile.Source.FullName);
_log.LogInformation("Found {Count} changes that still require updates to: {RedirectFile}", missingCount, relativeRedirectFile);
}

await collector.StopAsync(ctx);
Expand Down
Loading