Add matrix to pr workflow

.github/workflows/pr.yml

@@ -5,10 +5,6 @@ on:
 
 permissions:
   contents: read
-  packages: read
-  id-token: write
-  pull-requests: write
-  deployments: write
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -19,26 +15,26 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    steps:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+         - ubuntu-latest
+         - macos-latest
+         - windows-latest
+    steps:          
       - uses: actions/checkout@v4
 
       - name: Bootstrap Action Workspace
         id: bootstrap
         uses: ./.github/actions/bootstrap
 
       - name: Build
-        run: ./build.sh
+        run: dotnet run --project build -c release
 
       - name: Test
-        run: ./build.sh test
+        run: dotnet run --project build -c release -- test
 
       - name: Publish AOT
-        run: ./build.sh publishbinaries
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: docs-builder-binary
-          path: .artifacts/publish/docs-builder/release/docs-builder
-          if-no-files-found: error
-          retention-days: 1
+        run: dotnet run --project build -c release -- publishbinaries

docs-builder.sln

@@ -102,7 +102,6 @@ Global
 		{10857974-6CF1-42B5-B793-AAA988BD7348}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{10857974-6CF1-42B5-B793-AAA988BD7348}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{10857974-6CF1-42B5-B793-AAA988BD7348}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{10857974-6CF1-42B5-B793-AAA988BD7348}.Release|Any CPU.Build.0 = Release|Any CPU
 		{28350800-B44B-479B-86E2-1D39E321C0B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{28350800-B44B-479B-86E2-1D39E321C0B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{28350800-B44B-479B-86E2-1D39E321C0B4}.Release|Any CPU.ActiveCfg = Release|Any CPU

src/Elastic.Markdown.Refactor/Move.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information
 
 using System.IO.Abstractions;
+using System.Runtime.InteropServices;
 using System.Text.RegularExpressions;
 using Elastic.Markdown.IO;
 using Microsoft.Extensions.Logging;
@@ -64,6 +65,9 @@ private async Task SetupChanges(ChangeSet changeSet, Cancel ctx)
 				var fullPath = Path.GetFullPath(Path.Combine(sourceDirectory, originalPath));
 				var relativePath = Path.GetRelativePath(targetDirectory, fullPath);
 
+				if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+					relativePath = relativePath.Replace('\\', '/');
+
 				newPath = originalPath.StartsWith("./", OrdinalIgnoreCase) && !relativePath.StartsWith("./", OrdinalIgnoreCase)
 					? "./" + relativePath
 					: relativePath;
@@ -258,6 +262,15 @@ string targetPath
 		var absolutStyleSource = $"/{relativeToDocsFolder}";
 		var relativeToDocsFolderTarget = Path.GetRelativePath(documentationSet.SourceDirectory.FullName, targetPath);
 		var absoluteStyleTarget = $"/{relativeToDocsFolderTarget}";
+
+		if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+		{
+			relativeSource = relativeSource.Replace('\\', '/');
+			relativeSourceWithDotSlash = relativeSourceWithDotSlash.Replace('\\', '/');
+			absolutStyleSource = absolutStyleSource.Replace('\\', '/');
+			absoluteStyleTarget = absoluteStyleTarget.Replace('\\', '/');
+		}
+
 		return (
 			relativeSource,
 			relativeSourceWithDotSlash,
@@ -298,6 +311,9 @@ private string ReplaceLinks(
 						: $"[{match.Groups[1].Value}]({relativeTarget}{anchor})";
 				}
 
+				if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+					newLink = newLink.Replace('\\', '/');
+
 				var lineNumber = content[..match.Index].Count(c => c == '\n') + 1;
 				var columnNumber = match.Index - content.LastIndexOf('\n', match.Index);
 				if (!_linkModifications.ContainsKey(changeSet))

src/Elastic.Markdown/IO/MarkdownFile.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information
 
 using System.IO.Abstractions;
+using System.Runtime.InteropServices;
 using Elastic.Markdown.Diagnostics;
 using Elastic.Markdown.Helpers;
 using Elastic.Markdown.IO.Navigation;
@@ -95,6 +96,8 @@ public string Url
 		get
 		{
 			var relativePath = RelativePathUrl;
+			if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+				relativePath = relativePath.Replace('\\', '/');
 			return Path.GetFileName(relativePath) == "index.md"
 				? $"{UrlPathPrefix}/{relativePath.Remove(relativePath.LastIndexOf("index.md", StringComparison.Ordinal), "index.md".Length)}"
 				: $"{UrlPathPrefix}/{relativePath.Remove(relativePath.LastIndexOf(SourceFile.Extension, StringComparison.Ordinal), SourceFile.Extension.Length)}";

src/Elastic.Markdown/IO/State/LinkReference.cs

@@ -2,6 +2,7 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using System.Runtime.InteropServices;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using Elastic.Markdown.IO.Discovery;
@@ -70,7 +71,9 @@ public static LinkReference Create(DocumentationSet set)
 		var crossLinks = set.Build.Collector.CrossLinks.ToHashSet().ToArray();
 		var links = set.MarkdownFiles.Values
 			.Select(m => (m.RelativePath, File: m))
-			.ToDictionary(k => k.RelativePath, v =>
+			.ToDictionary(k => RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+			? k.RelativePath.Replace('\\', '/')
+			: k.RelativePath, v =>
 			{
 				var anchors = v.File.Anchors.Count == 0 ? null : v.File.Anchors.ToArray();
 				return new LinkMetadata { Anchors = anchors, Hidden = v.File.Hidden };

src/Elastic.Markdown/Myst/InlineParsers/DiagnosticLinkInlineParser.cs

@@ -5,6 +5,7 @@
 using System.Collections.Immutable;
 using System.Diagnostics.CodeAnalysis;
 using System.IO.Abstractions;
+using System.Runtime.InteropServices;
 using System.Text.RegularExpressions;
 using Elastic.Markdown.Diagnostics;
 using Elastic.Markdown.Helpers;
@@ -271,6 +272,10 @@ private static void UpdateLinkUrl(LinkInline link, string url, ParserContext con
 		if (!string.IsNullOrWhiteSpace(url) && !string.IsNullOrWhiteSpace(urlPathPrefix))
 			url = $"{urlPathPrefix.TrimEnd('/')}{url}";
 
+		// When running on Windows, path traversal results must be normalized prior to being used in a URL
+		if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+			url = url.Replace('\\', '/');
+
 		link.Url = string.IsNullOrEmpty(anchor) ? url : $"{url}#{anchor}";
 	}
 

tests/Elastic.Markdown.Tests/CodeBlocks/CallOutTests.cs

@@ -118,7 +118,7 @@ public void ParsesMagicCallOuts() => Block!.CallOuts
 
 	[Fact]
 	public void RendersExpectedHtml() =>
-		Html.Should().Contain("""
+		Html.ReplaceLineEndings().Should().Contain("""
 		                      <div class="highlight-csharp notranslate">
 		                      	<div class="highlight">
 		                      		<pre><code class="language-csharp">var x = 1; <span class="code-callout" data-index="1">1</span>
@@ -132,7 +132,7 @@ public void RendersExpectedHtml() =>
 		                      <li>Marking the first callout</li>
 		                      <li>Marking the second callout</li>
 		                      </ol>
-		                      """);
+		                      """.ReplaceLineEndings());
 
 
 	[Fact]
@@ -367,12 +367,12 @@ public void ParsesCallouts() => Block!.CallOuts
 
 	[Fact]
 	public void RenderedHtmlContainsCallouts() =>
-		Html.Should().Contain("""
+		Html.ReplaceLineEndings().Should().Contain("""
                               <ol class="code-callouts">
                               <li>First callout</li>
                               <li>Second callout</li>
                               </ol>
-                              """);
+                              """.ReplaceLineEndings());
 }
 
 public class CodeBlockWithMultipleCommentTypesThenList(ITestOutputHelper output) : CodeBlockCallOutTests(output, "csharp",
@@ -426,10 +426,10 @@ public void ParsesCallouts() => Block!.CallOuts
 
 	[Fact]
 	public void RendersIntermediateParagraph() =>
-		Html.Should().Contain("""
+		Html.ReplaceLineEndings().Should().Contain("""
                               <p><strong>This is an intermediate paragraph</strong></p>
                               <ol class="code-callouts">
-                              """);
+                              """.ReplaceLineEndings());
 }
 
 public class CodeBlockWithCommentBlocksTwoParagraphsThenList(ITestOutputHelper output) : CodeBlockCallOutTests(output, "csharp",

tests/Elastic.Markdown.Tests/DocSet/BreadCrumbTests.cs

@@ -12,7 +12,7 @@ public class BreadCrumbTests(ITestOutputHelper output) : NavigationTestsBase(out
 	[Fact]
 	public void ParsesATableOfContents()
 	{
-		var doc = Generator.DocumentationSet.Files.FirstOrDefault(f => f.RelativePath == "testing/nested/index.md") as MarkdownFile;
+		var doc = Generator.DocumentationSet.Files.FirstOrDefault(f => f.RelativePath == Path.Combine("testing", "nested", "index.md")) as MarkdownFile;
 
 		doc.Should().NotBeNull();
 

tests/Elastic.Markdown.Tests/DocSet/NavigationTests.cs

@@ -17,14 +17,14 @@ public void ParsesNestedFoldersAndPrefixesPaths()
 	{
 		Configuration.ImplicitFolders.Should().NotBeNullOrEmpty();
 		Configuration.ImplicitFolders.Should()
-			.Contain("testing/nested");
+			.Contain(Path.Combine("testing", "nested"));
 	}
 
 	[Fact]
 	public void ParsesFilesAndPrefixesPaths() =>
 		Configuration.Files.Should()
 			.Contain("index.md")
-			.And.Contain("syntax/index.md");
+			.And.Contain(Path.Combine("syntax", "index.md"));
 
 	[Fact]
 	public void ParsesRedirects()

tests/Elastic.Markdown.Tests/DocSet/NestedTocTests.cs

@@ -12,7 +12,7 @@ public class NestedTocTests(ITestOutputHelper output) : NavigationTestsBase(outp
 	[Fact]
 	public void InjectsNestedTocsIntoDocumentationSet()
 	{
-		var doc = Generator.DocumentationSet.Files.FirstOrDefault(f => f.RelativePath == "development/index.md") as MarkdownFile;
+		var doc = Generator.DocumentationSet.Files.FirstOrDefault(f => f.RelativePath == Path.Combine("development", "index.md")) as MarkdownFile;
 
 		doc.Should().NotBeNull();
 

tests/Elastic.Markdown.Tests/Inline/InlineAnchorTests.cs

@@ -111,11 +111,11 @@ public class InlineAnchorInHeading(ITestOutputHelper output) : BlockTest<Heading
 	[Fact]
 	public void GeneratesAttributesInHtml() =>
 		// language=html
-		Html.Should().Be(
+		Html.ReplaceLineEndings().TrimEnd().Should().Be(
 			"""
 			<div class="heading-wrapper" id="hello-world"><h2><a class="headerlink" href="#hello-world">Hello world <a id="my-anchor"></a></a></h2>
 			</div>
-			""".TrimEnd()
+			""".ReplaceLineEndings().TrimEnd()
 		);
 }
 
@@ -128,11 +128,11 @@ public class ExplicitSlugInHeader(ITestOutputHelper output) : BlockTest<HeadingB
 	[Fact]
 	public void GeneratesAttributesInHtml() =>
 		// language=html
-		Html.Should().Be(
+		Html.ReplaceLineEndings().TrimEnd().Should().Be(
 			"""
 			<div class="heading-wrapper" id="my-anchor"><h2><a class="headerlink" href="#my-anchor">Hello world</a></h2>
 			</div>
-			""".TrimEnd()
+			""".ReplaceLineEndings().TrimEnd()
 		);
 }
 

tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs

@@ -267,15 +267,15 @@ public class CommentedNonExistingLinks2(ITestOutputHelper output) : LinkTestBase
 	[Fact]
 	public void GeneratesHtml() =>
 		// language=html
-		Html.TrimEnd().Should().Be("""
+		Html.ReplaceLineEndings().TrimEnd().Should().Be("""
 		<p>Links:</p>
 		<ul>
 		<li><a href="/docs/testing/req" hx-get="/docs/testing/req" hx-select-oob="#primary-nav,#secondary-nav,#content-container" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="true">Special Requirements</a></li>
 		</ul>
 		<ul>
 		<li><a href="/docs/testing/req" hx-get="/docs/testing/req" hx-select-oob="#primary-nav,#secondary-nav,#content-container" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="true">Special Requirements</a></li>
 		</ul>
-		""");
+		""".ReplaceLineEndings());
 
 	[Fact]
 	public void HasErrors() => Collector.Diagnostics.Should().HaveCount(0);

tests/Elastic.Markdown.Tests/Inline/InlneBaseTests.cs

@@ -2,6 +2,7 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 using System.IO.Abstractions.TestingHelpers;
+using System.Runtime.InteropServices;
 using Elastic.Markdown.IO;
 using FluentAssertions;
 using JetBrains.Annotations;
@@ -103,8 +104,10 @@ protected InlineTest(
 		// ReSharper disable once VirtualMemberCallInConstructor
 		// nasty but sub implementations won't use class state.
 		AddToFileSystem(FileSystem);
-
-		var root = FileSystem.DirectoryInfo.New(Path.Combine(Paths.Root.FullName, "docs/"));
+		var baseRootPath = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+		 ? Paths.Root.FullName.Replace('\\', '/')
+		 : Paths.Root.FullName;
+		var root = FileSystem.DirectoryInfo.New($"{baseRootPath}/docs/");
 		FileSystem.GenerateDocSetYaml(root, globalVariables);
 
 		Collector = new TestDiagnosticsCollector(output);

tests/Elastic.Markdown.Tests/Mover/MoverTests.cs

@@ -28,15 +28,15 @@ public async Task RelativeLinks()
 		linkModifications.Should().HaveCount(3);
 
 
-		Path.GetRelativePath(".", linkModifications[0].SourceFile).Should().Be("testing/mover/first-page.md");
+		Path.GetRelativePath(".", linkModifications[0].SourceFile).Should().Be(Path.Combine("testing", "mover", "first-page.md"));
 		linkModifications[0].OldLink.Should().Be("[Link to second page](second-page.md)");
 		linkModifications[0].NewLink.Should().Be("[Link to second page](../testing/mover/second-page.md)");
 
-		Path.GetRelativePath(".", linkModifications[1].SourceFile).Should().Be("testing/mover/second-page.md");
+		Path.GetRelativePath(".", linkModifications[1].SourceFile).Should().Be(Path.Combine("testing", "mover", "second-page.md"));
 		linkModifications[1].OldLink.Should().Be("[Link to first page](first-page.md)");
 		linkModifications[1].NewLink.Should().Be("[Link to first page](../../new-folder/hello-world.md)");
 
-		Path.GetRelativePath(".", linkModifications[2].SourceFile).Should().Be("testing/mover/second-page.md");
+		Path.GetRelativePath(".", linkModifications[2].SourceFile).Should().Be(Path.Combine("testing", "mover", "second-page.md"));
 		linkModifications[2].OldLink.Should().Be("[Absolut link to first page](/testing/mover/first-page.md)");
 		linkModifications[2].NewLink.Should().Be("[Absolut link to first page](/new-folder/hello-world.md)");
 	}
@@ -56,15 +56,15 @@ public async Task MoveToFolder()
 		var linkModifications = mover.LinkModifications[changeSet];
 		linkModifications.Should().HaveCount(3);
 
-		Path.GetRelativePath(".", linkModifications[0].SourceFile).Should().Be("testing/mover/first-page.md");
+		Path.GetRelativePath(".", linkModifications[0].SourceFile).Should().Be(Path.Combine("testing", "mover", "first-page.md"));
 		linkModifications[0].OldLink.Should().Be("[Link to second page](second-page.md)");
 		linkModifications[0].NewLink.Should().Be("[Link to second page](../testing/mover/second-page.md)");
 
-		Path.GetRelativePath(".", linkModifications[1].SourceFile).Should().Be("testing/mover/second-page.md");
+		Path.GetRelativePath(".", linkModifications[1].SourceFile).Should().Be(Path.Combine("testing", "mover", "second-page.md"));
 		linkModifications[1].OldLink.Should().Be("[Link to first page](first-page.md)");
 		linkModifications[1].NewLink.Should().Be("[Link to first page](../../new-folder/first-page.md)");
 
-		Path.GetRelativePath(".", linkModifications[2].SourceFile).Should().Be("testing/mover/second-page.md");
+		Path.GetRelativePath(".", linkModifications[2].SourceFile).Should().Be(Path.Combine("testing", "mover", "second-page.md"));
 		linkModifications[2].OldLink.Should().Be("[Absolut link to first page](/testing/mover/first-page.md)");
 		linkModifications[2].NewLink.Should().Be("[Absolut link to first page](/new-folder/first-page.md)");
 	}
@@ -84,15 +84,15 @@ public async Task MoveFolderToFolder()
 		var linkModifications = mover.LinkModifications[changeSet];
 		linkModifications.Should().HaveCount(3);
 
-		Path.GetRelativePath(".", linkModifications[0].SourceFile).Should().Be("testing/mover/first-page.md");
+		Path.GetRelativePath(".", linkModifications[0].SourceFile).Should().Be(Path.Combine("testing", "mover", "first-page.md"));
 		linkModifications[0].OldLink.Should().Be("[Link to second page](second-page.md)");
 		linkModifications[0].NewLink.Should().Be("[Link to second page](../testing/mover/second-page.md)");
 
-		Path.GetRelativePath(".", linkModifications[1].SourceFile).Should().Be("testing/mover/second-page.md");
+		Path.GetRelativePath(".", linkModifications[1].SourceFile).Should().Be(Path.Combine("testing", "mover", "second-page.md"));
 		linkModifications[1].OldLink.Should().Be("[Link to first page](first-page.md)");
 		linkModifications[1].NewLink.Should().Be("[Link to first page](../../new-folder/first-page.md)");
 
-		Path.GetRelativePath(".", linkModifications[2].SourceFile).Should().Be("testing/mover/second-page.md");
+		Path.GetRelativePath(".", linkModifications[2].SourceFile).Should().Be(Path.Combine("testing", "mover", "second-page.md"));
 		linkModifications[2].OldLink.Should().Be("[Absolut link to first page](/testing/mover/first-page.md)");
 		linkModifications[2].NewLink.Should().Be("[Absolut link to first page](/new-folder/first-page.md)");
 	}

tests/authoring/Framework/MarkdownResultsAssertions.fs

@@ -11,6 +11,7 @@ open DiffPlex.DiffBuilder.Model
 open FsUnit.Xunit
 open JetBrains.Annotations
 open Xunit.Sdk
+open System.IO
 
 [<AutoOpen>]
 module ResultsAssertions =
@@ -50,7 +51,7 @@ module ResultsAssertions =
 
         let result =
             results.MarkdownResults
-            |> Seq.tryFind (fun m -> m.File.RelativePath = file)
+            |> Seq.tryFind (fun m -> m.File.RelativePath = (string file).Replace('/', Path.DirectorySeparatorChar))
 
         match result with
         | None ->