Optimize workflow logic and improve Vale style checking

- Move Vale installation to docs-setup action for better reusability - Remove duplicate Vale installation step from shared action - Add empty file check to Vale style checking for robustness - Update workflow to conditionally install Vale based on input parameter - Make Vale configuration more explicit with improved comments - Ensure consistent use of pre-processed file lists
coder · EdwardAngert · Apr 9, 2025 · Apr 9, 2025 · Apr 9, 2025 · Apr 9, 2025
commit 6420b3f05a9bf8773f95c1990da32faa1c698581
diff --git a/.github/docs/actions/docs-setup/action.yaml b/.github/docs/actions/docs-setup/action.yaml
@@ -11,6 +11,10 @@ inputs:
     description: 'Git fetch depth'
     required: false
     default: '0'
+  setup-vale:
+    description: 'Whether to setup Vale for style checking'
+    required: false
+    default: 'true'
 
 runs:
   using: 'composite'
@@ -33,4 +37,11 @@ runs:
 
     - name: Install dependencies
       shell: bash
-      run: ./scripts/pnpm_install.sh
+      run: ./scripts/pnpm_install.sh
+
+    - name: Install Vale
+      if: inputs.setup-vale == 'true'
+      uses: errata-ai/vale-action@v2
+      with:
+        config: .github/docs/vale/.vale.ini
+        files: ""  # Don't run Vale yet, just install it
diff --git a/.github/docs/actions/docs-shared/action.yaml b/.github/docs/actions/docs-shared/action.yaml
@@ -309,18 +309,20 @@ runs:
         fail_on_error: ${{ inputs.fail-on-error }}
         filter_mode: "nofilter"
 
-    - name: Install Vale
-      if: inputs.lint-vale == 'true' && steps.docs-analysis.outputs.has_changes == 'true'
-      uses: errata-ai/vale-action@v2
-      with:
-        config: .github/docs/vale/.vale.ini
-
     - name: Run Vale style checks
       if: inputs.lint-vale == 'true' && steps.docs-analysis.outputs.has_changes == 'true'
       id: lint-vale
       shell: bash
       run: |
+        # Run Vale on changed markdown files using our pre-processed list
+        # First check if we have any markdown files to process
+        if [ -z "${{ steps.process-files.outputs.md_files_line }}" ]; then
+          echo "No markdown files to check"
+          exit 0
+        fi
+
         # Run Vale on changed files and capture output
+        # Use xargs with -r to skip execution if no files are provided
         vale_output=$(echo "${{ steps.process-files.outputs.md_files_line }}" | xargs -r vale --config=.github/docs/vale/.vale.ini --output=line 2>&1) || true
 
         echo "result<<EOF" >> $GITHUB_OUTPUT

diff --git a/.github/workflows/docs-unified.yaml b/.github/workflows/docs-unified.yaml
@@ -58,6 +58,8 @@ jobs:
 
       - name: Setup Environment
         uses: ./.github/docs/actions/docs-setup
+        with:
+          setup-vale: ${{ inputs.lint-vale }}
 
       - name: Get PR info
         id: pr_info