Lint markdown files

Author: IVNSTN

.github/workflows/ci.yml

@@ -8,6 +8,12 @@ on:
     branches: ["main"]
   pull_request:
     branches: ["main"]
+  workflow_dispatch:
+    inputs:
+      target_branch:
+        description: 'Branch to run on'
+        required: true
+        default: 'main'
 
 env:
   PRODUCT_NAME: TeamTools.Linter.CommandLine
@@ -185,6 +191,27 @@ jobs:
           path: "**/TestResults/*.trx,*.trx"
           reporter: dotnet-trx
 
+  validate-markdown:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: lts/*
+
+      - name: Install markdownlint
+        run: >
+          npm install markdownlint-cli2 --global
+
+      - name: Run linting
+        run: >
+          markdownlint-cli2
+          "**/*.md"
+          "!node_modules"
+          "!packages"
+          --config ${{ github.workspace }}/.markdownlint.jsonc
+
   report:
     name: Update badges
     needs: [build]
@@ -230,7 +257,7 @@ jobs:
 
   repack-with-plugins:
     name: Repackage with plugins
-    needs: [semver, build]
+    needs: [semver, build, validate-markdown]
     if: ${{ always() && needs.build.outputs.build-result == 'success' }}
     runs-on: ubuntu-latest
 

.markdownlint.jsonc

@@ -0,0 +1,13 @@
+{
+    "default": true, // Default state for all rules
+    "MD012": false, // extra line [2 empty lines]
+    "MD013": false, // line length
+    "MD033": {
+        "allowed_elements": [ "p" ]
+    },
+    "MD055": false, // tables
+    "MD060": false, // table column style
+    "MD004": {
+        "style": "dash" // List style
+    }
+}

Directory.Build.props

@@ -78,6 +78,18 @@
     <IncludeSourceRevisionInInformationalVersion>true</IncludeSourceRevisionInInformationalVersion>
   </PropertyGroup>
 
+  <!-- Target OS related flags -->
+  <PropertyGroup>
+    <IsWindows Condition="'$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)))' == 'true'">true</IsWindows>
+    <IsLinux Condition="'$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Linux)))' == 'true'">true</IsLinux>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(IsWindows)'=='true'">
+     <DefineConstants>Windows</DefineConstants>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(IsLinux)'=='true'">
+    <DefineConstants>Linux</DefineConstants>
+  </PropertyGroup>
+
   <!-- No packing for test projects -->
   <PropertyGroup Condition="'$(IsTestProject)'=='true'">
     <IsPackable>false</IsPackable>
@@ -101,6 +113,6 @@
     </PackageReference>
     <None Include="$(MSBuildProjectDirectory)\packages.lock.json" Visible="false" />
     <!-- Newer version helps better resolving common dll dependencies -->
-    <PackageReference Include="Microsoft.NETCore.Platforms" Version="7.0.4"  Condition="'$(IsTestProject)' != 'true'" />
+    <PackageReference Include="Microsoft.NETCore.Platforms" Version="7.0.4" Condition="'$(IsTestProject)' != 'true'" />
   </ItemGroup>
 </Project>