Skip to content

Add lastmod and ensure we also add DocumentationGroup navigation items #1124

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 1 commit into from
Apr 15, 2025
Merged

Add lastmod and ensure we also add DocumentationGroup navigation items #1124

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
22 changes: 15 additions & 7 deletions src/docs-assembler/Building/SitemapBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,24 @@

namespace Documentation.Assembler.Building;

public class SitemapBuilder(IReadOnlyCollection<INavigationItem> navigationItems, IFileSystem fileSystem, IDirectoryInfo outputFolder)
public class SitemapBuilder(
IReadOnlyCollection<INavigationItem> navigationItems,
IFileSystem fileSystem,
IDirectoryInfo outputFolder
)
{
private static readonly Uri BaseUri = new("https://www.elastic.co");
private readonly IReadOnlyCollection<INavigationItem> _navigationItems = navigationItems;
private readonly IFileSystem _fileSystem = fileSystem;
private readonly IDirectoryInfo _outputFolder = outputFolder;

public void Generate()
{
var flattenedNavigationItems = GetNavigationItems(_navigationItems);
var flattenedNavigationItems = GetNavigationItems(navigationItems);

var doc = new XDocument()
{
Declaration = new XDeclaration("1.0", "utf-8", "yes"),
};

var currentDate = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:sszzz");
var root = new XElement(
"urlset",
new XAttribute("xlmns", "http://www.sitemaps.org/schemas/sitemap/0.9"),
Expand All @@ -32,12 +34,15 @@ public void Generate()
.Select(n => n.File.Url)
.Distinct()
.Select(u => new Uri(BaseUri, u))
.Select(u => new XElement("url", new XElement("loc", u)))
.Select(u => new XElement("url", [
new XElement("loc", u),
new XElement("lastmod", currentDate)
]))
);

doc.Add(root);

using var fileStream = _fileSystem.File.Create(Path.Combine(_outputFolder.ToString() ?? string.Empty, "docs", "sitemap.xml"));
using var fileStream = fileSystem.File.Create(Path.Combine(outputFolder.ToString() ?? string.Empty, "docs", "sitemap.xml"));
doc.Save(fileStream);
}

Expand All @@ -54,6 +59,9 @@ private static IReadOnlyCollection<INavigationItem> GetNavigationItems(IReadOnly
case GroupNavigationItem group:
result.AddRange(GetNavigationItems(group.Group.NavigationItems));
break;
case DocumentationGroup group:
result.AddRange(GetNavigationItems(group.NavigationItems));
break;
}
}
return result;
Expand Down
Loading