GitTools#4017 - use MarkdownSnippets tool to embed .yml files as code snippet in markdown

Author: arturcic

.github/workflows/format.yml

@@ -37,7 +37,9 @@ jobs:
     runs-on: ubuntu-latest
     name: DotNet Format
     steps:
-      - uses: actions/checkout@v4
+      -
+        name: Checkout
+        uses: actions/checkout@v4
       -
         name: Setup .NET SDK
         uses: actions/setup-dotnet@v4

.github/workflows/mkdocs.yml

@@ -0,0 +1,41 @@
+name: Markdown Update
+on:
+  push:
+
+env:
+  DOTNET_ROLL_FORWARD: "Major"
+  DOTNET_CLI_TELEMETRY_OPTOUT: 1
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_NOLOGO: 1
+  
+defaults:
+  run:
+    shell: pwsh
+    
+jobs:
+  docs:
+    name: Update Markdown (embedded snippets)
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      - 
+        name: Run MarkdownSnippets
+        run: |
+          dotnet tool install --global MarkdownSnippets.Tool
+          mdsnippets ${GITHUB_WORKSPACE}
+      - 
+        name: Check for changes
+        id: status
+        run: |
+          if ($null -ne (git status --porcelain)) { echo "has_changes=1"; echo "has_changes=1" >> $env:GITHUB_OUTPUT }
+      - 
+        name: Push changes
+        run: |
+          git add --verbose .
+          git config user.name 'Artur Stolear'
+          git config user.email '[email protected]'
+          git commit -m 'Docs changes' --allow-empty
+          git push --force
+        if: steps.status.outputs.has_changes == '1'

.github/workflows/release.yml

@@ -8,15 +8,19 @@ jobs:
     name: Trigger ci flow
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Get version
+      -  
+        name: Checkout
+        uses: actions/checkout@v4
+      - 
+        name: Get version
         id: get-version
         shell: pwsh
         run: |
           # Finding the version from release tag
           $VERSION="${{ github.ref }}".Replace("refs/tags/", "")
           "version=$VERSION" >> $env:GITHUB_OUTPUT        
-      - uses: peter-evans/repository-dispatch@v3
+      - 
+        uses: peter-evans/repository-dispatch@v3
         with:
           token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
           repository: ${{ github.repository }}

build/CI.sln

@@ -42,6 +42,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
 		..\.github\workflows\_unit_tests.yml = ..\.github\workflows\_unit_tests.yml
 		..\.github\workflows\stale.yml = ..\.github\workflows\stale.yml
 		..\.github\workflows\winget.yml = ..\.github\workflows\winget.yml
+		..\.github\workflows\mkdocs.yml = ..\.github\workflows\mkdocs.yml
 		..\.github\dependabot.yml = ..\.github\dependabot.yml
 	EndProjectSection
 EndProject