Merge remote-tracking branch 'origin/main' into feature/limited-width-layout-2

Author: Mpdreamz

.github/dependabot.yml

@@ -24,5 +24,10 @@ updates:
       interval: 'weekly'
       day: 'monday'
       time: '08:00'
+    groups: 
+      system-io-abstractions:
+        patterns:
+          - 'System.IO.Abstractions'
+          - 'System.IO.Abstractions.*'
     labels:
       - chore

.github/workflows/preview-build.yml

@@ -175,10 +175,6 @@ jobs:
         if: contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name) && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master') && steps.s3-upload.outcome == 'success'
         uses: elastic/docs-builder/actions/update-link-index@main
 
-      - name: Update Reference Index
-        if: contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name) && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master') && steps.s3-upload.outcome == 'success'
-        uses: elastic/docs-builder/actions/update-reference-index@main
-
       - name: Update deployment status
         uses: actions/github-script@v7
         if: always() && steps.deployment.outputs.result

.github/workflows/preview-cleanup.yml

@@ -52,6 +52,3 @@ jobs:
           PR_NUMBER: ${{ github.event.pull_request.number }}
         run: |
           aws s3 rm "s3://elastic-docs-v3-website-preview/${GITHUB_REPOSITORY}/pull/${PR_NUMBER}" --recursive
-
-      - name: 'Update Reference Index'
-        uses: elastic/docs-builder/actions/update-reference-index@main

.github/workflows/release-drafter.yml

@@ -11,6 +11,8 @@ permissions:
 
 jobs:
   update-release-draft:
+    concurrency:
+      group: release-drafter
     permissions:
       contents: write
       pull-requests: read

.github/workflows/release.yml

@@ -1,14 +1,46 @@
-name: Pre-release main branch
+name: Release
 
 on:
-  release:
-    types: [published]
-
+  workflow_dispatch: 
+    
 permissions:
   contents: read
   packages: write
+    
+concurrency:
+  group: release-drafter
 
 jobs:
+  
+  release-drafter:
+    outputs:
+      tag_name: ${{ steps.release-drafter.outputs.tag_name }}
+    permissions:
+      contents: write
+      pull-requests: read
+    runs-on: ubuntu-latest
+    steps:
+      - name: Verify branch
+        run: |
+          if [[ "${{ github.ref }}" != refs/heads/main ]]; then
+            echo "This workflow is only allowed to run on the main branch."
+            exit 1
+          fi
+      - uses: release-drafter/release-drafter@b1476f6e6eb133afa41ed8589daba6dc69b4d3f5 # v6.1.0
+        id: release-drafter
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+      - name: Create tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: 'refs/tags/${{ steps.release-drafter.outputs.tag_name }}',
+              sha: context.sha
+            })
+  
   containers:
     runs-on: ubuntu-latest
     outputs:
@@ -17,7 +49,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-
+        with:
+          ref: ${{ steps.release-drafter.outputs.tag_name }}
       - name: Bootstrap Action Workspace
         id: bootstrap
         uses: ./.github/actions/bootstrap
@@ -29,32 +62,52 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-
       - name: Publish Containers
         run: ./build.sh publishcontainers
 
   release-lambda:
+    environment: 
+      name: link-index-updater-prod
     runs-on: ubuntu-latest
+    needs:
+      - release-drafter
     permissions:
       contents: write
+      id-token: write
+    env: 
+      ZIP_FILE: link-index-updater-lambda.zip
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ steps.release-drafter.outputs.tag_name }}
       - name: Amazon Linux 2023 build
         run: |
           docker build . -t publish-links-index:latest -f src/infra/docs-lambda-index-publisher/lambda.DockerFile
       - name: Get bootstrap binary
         run: |
           docker cp $(docker create --name tc publish-links-index:latest):/app/.artifacts/publish ./.artifacts && docker rm tc
-
-      # TODO publish to AWS
+      
+      - uses: aws-actions/configure-aws-credentials@ececac1a45f3b08a01d2dd070d28d111c5fe6722 # v4.1.0
+        with:
+          role-to-assume: arn:aws:iam::197730964718:role/elastic-docs-v3-link-index-updater-deployer
+          aws-region: us-east-2
+          
+      - name: Upload Lambda function
+        run: |        
+          zip -j "${ZIP_FILE}" .artifacts/docs-lambda-index-publisher/release_linux-x64/bootstrap
+          aws lambda update-function-code \
+            --function-name elastic-docs-v3-link-index-updater \
+            --zip-file "fileb://${ZIP_FILE}"
+      
       - name: Attach Distribution to release
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: gh release upload ${{ github.event.release.tag_name }} .artifacts/docs-lambda-index-publisher/release_linux-x64/bootstrap
-        shell: bash
+        run: gh release upload ${{ needs.release-drafter.outputs.tag_name }} "${ZIP_FILE}"
 
   release:
-    needs: [containers]
+    needs: 
+      - containers
+      - release-drafter
     strategy:
       fail-fast: false
       matrix:
@@ -70,6 +123,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ steps.release-drafter.outputs.tag_name }}
 
       - name: Bootstrap Action Workspace
         id: bootstrap
@@ -90,6 +145,22 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          gh release upload ${{ github.event.release.tag_name }} .artifacts/publish/docs-builder/release/*.zip
-          gh release upload ${{ github.event.release.tag_name }} .artifacts/publish/docs-assembler/release/*.zip
+          gh release upload ${{ needs.release-drafter.outputs.tag_name }} .artifacts/publish/docs-builder/release/*.zip
+          gh release upload ${{ needs.release-drafter.outputs.tag_name }} .artifacts/publish/docs-assembler/release/*.zip
         shell: bash
+    
+  publish-release:
+    needs:
+      - release
+      - release-lambda
+      - release-drafter
+    runs-on: ubuntu-latest
+    permissions: 
+      contents: write
+    steps:
+      - name: Publish release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG_NAME: ${{ needs.release-drafter.outputs.tag_name }}
+        run: |
+          gh release edit ${{ needs.release-drafter.outputs.tag_name }} --draft=false --latest --repo ${{ github.repository }}

Directory.Packages.props

@@ -8,12 +8,14 @@
   </ItemGroup>
   <!-- AWS -->
   <ItemGroup>
-    <PackageVersion Include="Amazon.Lambda.RuntimeSupport" Version="1.13.0"/>
-    <PackageVersion Include="Amazon.Lambda.Core" Version="2.5.1"/>
-    <PackageVersion Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.4"/>
-    <PackageVersion Include="AWSSDK.S3" Version="3.7.416.9"/>
+    <PackageVersion Include="Amazon.Lambda.RuntimeSupport" Version="1.13.0" />
+    <PackageVersion Include="Amazon.Lambda.Core" Version="2.5.1" />
+    <PackageVersion Include="Amazon.Lambda.S3Events" Version="3.1.0" />
+    <PackageVersion Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.4" />
+    <PackageVersion Include="Amazon.Lambda.SQSEvents" Version="2.2.0" />
+    <PackageVersion Include="AWSSDK.SQS" Version="3.7.400.135" />
+    <PackageVersion Include="AWSSDK.S3" Version="3.7.416.16"/>
   </ItemGroup>
-
   <!-- Build -->
   <ItemGroup>
     <PackageVersion Include="Argu" Version="6.2.5" />
@@ -23,42 +25,41 @@
     <PackageVersion Include="Fake.IO.Zip" Version="6.1.3" />
     <PackageVersion Include="FSharp.Core" Version="9.0.202" />
   </ItemGroup>
-
   <ItemGroup>
-    <PackageVersion Include="ConsoleAppFramework" Version="5.4.1" PrivateAssets="all" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive"/>
+    <PackageVersion Include="ConsoleAppFramework" Version="5.4.1" PrivateAssets="all" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive" />
     <PackageVersion Include="ConsoleAppFramework.Abstractions" Version="5.4.1" />
-    <PackageVersion Include="Crayon" Version="2.0.69"/>
+    <PackageVersion Include="Crayon" Version="2.0.69" />
     <PackageVersion Include="DotNet.Glob" Version="3.1.3" />
-    <PackageVersion Include="Errata" Version="0.13.0" />
+    <PackageVersion Include="Errata" Version="0.14.0" />
     <PackageVersion Include="Github.Actions.Core" Version="9.0.0"/>
-    <PackageVersion Include="Markdig" Version="0.40.0" />
-    <PackageVersion Include="Microsoft.Extensions.Logging" Version="9.0.4"/>
-    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.4"/>
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="9.0.4" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.4" />
+    <PackageVersion Include="Markdig" Version="0.41.1" />
     <PackageVersion Include="NetEscapades.EnumGenerators" Version="1.0.0-beta12" PrivateAssets="all" ExcludeAssets="runtime" />
     <PackageVersion Include="Proc" Version="0.9.1" />
     <PackageVersion Include="RazorSlices" Version="0.8.1" />
     <PackageVersion Include="Samboy063.Tomlet" Version="6.0.0" />
     <PackageVersion Include="Slugify.Core" Version="4.0.1" />
     <PackageVersion Include="SoftCircuits.IniFileParser" Version="2.7.0" />
-    <PackageVersion Include="System.IO.Abstractions" Version="21.0.29" />
-    <PackageVersion Include="Utf8StreamReader" Version="1.3.2"/>
-    <PackageVersion Include="Vecc.YamlDotNet.Analyzers.StaticGenerator" Version="16.1.3" PrivateAssets="All"/>
+    <PackageVersion Include="System.IO.Abstractions" Version="22.0.14" />
+    <PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="9.0.4" />
+    <PackageVersion Include="Utf8StreamReader" Version="1.3.2" />
+    <PackageVersion Include="Vecc.YamlDotNet.Analyzers.StaticGenerator" Version="16.1.3" PrivateAssets="All" />
     <PackageVersion Include="Westwind.AspNetCore.LiveReload" Version="0.5.2" />
     <PackageVersion Include="YamlDotNet" Version="16.3.0" />
   </ItemGroup>
-
   <!-- Test packages -->
   <ItemGroup>
-    <PackageVersion Include="AngleSharp.Diffing" Version="1.0.0"/>
-    <PackageVersion Include="DiffPlex" Version="1.7.2"/>
-    <PackageVersion Include="FluentAssertions" Version="6.12.1"/>
-    <PackageVersion Include="FsUnit.xUnit" Version="7.0.1"/>
+    <PackageVersion Include="AngleSharp.Diffing" Version="1.0.0" />
+    <PackageVersion Include="DiffPlex" Version="1.7.2" />
+    <PackageVersion Include="FluentAssertions" Version="6.12.1" />
+    <PackageVersion Include="FsUnit.xUnit" Version="7.0.1" />
     <PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
     <PackageVersion Include="JetBrains.Annotations" Version="2024.3.0" />
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0"/>
-    <PackageVersion Include="System.IO.Abstractions.TestingHelpers" Version="21.0.29"/>
-    <PackageVersion Include="Unquote" Version="7.0.1"/>
-    <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2"/>
-    <PackageVersion Include="xunit.v3" Version="1.1.0"/>
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
+    <PackageVersion Include="System.IO.Abstractions.TestingHelpers" Version="22.0.14" />
+    <PackageVersion Include="Unquote" Version="7.0.1" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2" />
+    <PackageVersion Include="xunit.v3" Version="1.1.0" />
   </ItemGroup>
-</Project>
+</Project>

Elastic.Documentation/ContentSourceMoniker.cs

@@ -0,0 +1,18 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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
+
+namespace Elastic.Documentation;
+
+public static class ContentSourceMoniker
+{
+	public static Uri Create(string repo, string? path) => new(CreateString(repo, path));
+
+	public static string CreateString(string repo, string? path)
+	{
+		path = path?.Replace("\\", "/").Trim('/');
+		if (string.IsNullOrWhiteSpace(path) || path == ".")
+			return $"{repo}://";
+		return $"{repo}://{path}/";
+	}
+}

Elastic.Documentation/Diagnostics/Diagnostic.cs

@@ -0,0 +1,15 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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
+
+namespace Elastic.Documentation.Diagnostics;
+
+public readonly record struct Diagnostic
+{
+	public Severity Severity { get; init; }
+	public int? Line { get; init; }
+	public int? Column { get; init; }
+	public int? Length { get; init; }
+	public string File { get; init; }
+	public string Message { get; init; }
+}

Elastic.Documentation/Diagnostics/DiagnosticsChannel.cs

@@ -0,0 +1,51 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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.Threading.Channels;
+
+namespace Elastic.Documentation.Diagnostics;
+
+public sealed class DiagnosticsChannel : IDisposable
+{
+	private readonly Channel<Diagnostic> _channel;
+	private readonly CancellationTokenSource _ctxSource;
+	public ChannelReader<Diagnostic> Reader => _channel.Reader;
+
+	public Cancel CancellationToken => _ctxSource.Token;
+
+	public DiagnosticsChannel()
+	{
+		var options = new UnboundedChannelOptions
+		{
+			SingleReader = true,
+			SingleWriter = false
+		};
+		_ctxSource = new CancellationTokenSource();
+		_channel = Channel.CreateUnbounded<Diagnostic>(options);
+	}
+
+	public void TryComplete(Exception? exception = null)
+	{
+		_ = _channel.Writer.TryComplete(exception);
+		_ctxSource.Cancel();
+	}
+
+	public ValueTask<bool> WaitToWrite(Cancel ctx) => _channel.Writer.WaitToWriteAsync(ctx);
+
+	public void Write(Diagnostic diagnostic)
+	{
+		var written = _channel.Writer.TryWrite(diagnostic);
+		if (!written)
+		{
+			//TODO
+		}
+	}
+
+	public void Dispose() => _ctxSource.Dispose();
+}
+
+public interface IDiagnosticsOutput
+{
+	void Write(Diagnostic diagnostic);
+}