Refactor docs lint workflow in docs-lint.yaml

matifali · matifali · commit e9431a6fde4b · 2024-12-11T15:33:57.000Z
- Restrict triggers to main branch and pull requests
- Remove automatic fix option in markdownlint-cli2 command
diff --git a/.github/workflows/docs-lint.yaml b/.github/workflows/docs-lint.yaml
@@ -1,8 +1,10 @@
-# Filtering pull requests is much easier when we can reliably guarantee
-# that the "Assignee" field is populated.
-name: Docs markdown lint
+name: Docs lint
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   lint:
@@ -11,15 +13,20 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+
+      - name: Setup Node
+        uses: ./.github/actions/setup-node
+
       - uses: tj-actions/changed-files@v45
         id: changed-files
         with:
           files: "docs/**/*.md"
           files_ignore: "docs/reference/*.md"
           separator: ","
+
       - name: lint
         if: steps.changed-files.outputs.any_changed == 'true'
         run: |
           cd site
           ../scripts/pnpm_install.sh
-          pnpm exec markdownlint-cli2 --fix {{ steps.changed-files.outputs.all_changed_files }}
+          pnpm exec markdownlint-cli2 {{ steps.changed-files.outputs.all_changed_files }}
