Markdown lint

Azure-Samples · Jun 7, 2024 · 1c0d5e3 · 1c0d5e3
1 parent caf2eba
commit 1c0d5e3
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 19 deletions.
diff --git a/.github/workflows/lint-markdown.yml b/.github/workflows/lint-markdown.yml
@@ -0,0 +1,18 @@
+name: Validate Markdown
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.md'
+
+jobs:
+  lint-markdown:
+    name: Check for Markdown linting errors
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Run markdownlint
+        uses: articulate/actions-markdownlint@v1
diff --git a/.github/workflows/validate-markdown.yml b/.github/workflows/validate-markdown.yml
@@ -14,25 +14,15 @@ permissions:
   pull-requests: write
 
 jobs:
-  lint-markdown:
-    name: Check for Markdown linting errors
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-      - name: Run markdownlint
-        uses: articulate/actions-markdownlint@v1
   check-broken-paths:
-    name: Check broken relative paths
+    name: Check Broken Relative Paths
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repo
+      - name: Checkout Repo
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
-      - name: Run check_broken_paths
+      - name: Check broken Paths
         id: check-broken-paths
         uses: john0isaac/action-check-markdown@v1.0.6
         with:
@@ -43,14 +33,14 @@ jobs:
   check-urls-locale:
     if: ${{ always() }}
     needs: check-broken-paths
-    name: Check URLs don't have locale
+    name: Check URLs Don't Have Locale
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repo
+      - name: Checkout Repo
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
-      - name: Run check_urls_locale
+      - name: Run Check URLs Country Locale
         id: check-urls-locale
         uses: john0isaac/action-check-markdown@v1.0.6
         with:
@@ -60,14 +50,14 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
   check-broken-urls:
     if: ${{ always() }}
-    name: Check broken URLs
+    name: Check Broken URLs
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repo
+      - name: Checkout Repo
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
-      - name: Run check_broken_urls
+      - name: Run Check Broken URLs
         id: check-broken-urls
         uses: john0isaac/action-check-markdown@v1.0.6
         with: