fix: resolve Vale configuration conflicts and inconsistencies

EdwardAngert · Claude · EdwardAngert · commit abe0d7c1ba3b · 2025-04-23T15:07:22.000-04:00
- Remove duplicate Vale execution in docs-core action - Add clear documentation about the single Vale execution point - Enable Vale consistently across all workflow configurations - Ensure consistent style checking across preview, CI, and link-check workflows 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/.github/docs/actions/docs-core/action.yaml b/.github/docs/actions/docs-core/action.yaml
@@ -688,35 +688,18 @@ runs:
         echo "message=Link checking is enabled" >> $GITHUB_OUTPUT
         echo "::endgroup::"
         
+    # Note: Style checking is now completely handled by errata-ai/vale-action in the unified workflow
+    # This step exists solely to maintain compatibility with the workflow structure
     - name: Report Vale style checking status
       id: lint-vale
       if: env.lint_vale == 'true' && steps.file-detection.outputs.has_changes == 'true'
       shell: bash
       run: |
         echo "::group::Vale style checking"
-        
-        echo "Style checking is performed via Vale GitHub Action"
-        CHANGED_FILES_JSON='${{ steps.file-detection.outputs.changed_files_json }}'
-        
-        # Check if we have a valid list of files
-        if [ "$CHANGED_FILES_JSON" == "[]" ] || [ -z "$CHANGED_FILES_JSON" ]; then
-          echo "No files to check"
-          echo "status=success" >> $GITHUB_OUTPUT
-          echo "message=No files to check for style issues" >> $GITHUB_OUTPUT
-          echo "::endgroup::"
-          exit 0
-        fi
-        
-        # Get the markdown files from changed files
-        MD_FILES_COUNT=$(echo "$CHANGED_FILES_JSON" | jq -r '.[]' | grep -c '\.md$' || echo "0")
-        
-        # Log the file count
-        echo "Found $MD_FILES_COUNT markdown files for style validation"
-        
-        # Vale is executed through GitHub Action - just report status
+        echo "Style checking is performed via the Vale GitHub Action"
+        echo "This step is a placeholder for compatibility with the workflow structure"
         echo "status=success" >> $GITHUB_OUTPUT
-        echo "message=Style validation via Vale GitHub Action" >> $GITHUB_OUTPUT
-        
+        echo "message=See Vale GitHub Action for style validation results" >> $GITHUB_OUTPUT
         echo "::endgroup::"
         
     - name: Check for broken cross-references
diff --git a/.github/workflows/docs-ci.yaml b/.github/workflows/docs-ci.yaml
@@ -29,12 +29,12 @@ jobs:
       pull-requests: write
     with:
       preset: 'ci'  # Use the CI preset for fast checks
-      # CI checks focus on formatting and linting, not links
+      # CI checks focus on formatting, linting, and style
       lint-markdown: true
       check-format: true
       check-links: false
       check-cross-references: false
-      lint-vale: false
+      lint-vale: true
       # Configuration for CI behavior
       generate-preview: false
       post-comment: false
diff --git a/.github/workflows/docs-link-check.yaml b/.github/workflows/docs-link-check.yaml
@@ -33,12 +33,12 @@ jobs:
       # Configure notifications
       notification-channels: 'github-issue,slack'
       issue-labels: 'documentation,bug,needs-triage'
-      # Only check what matters after merge
+      # Post-merge checks for links, cross-references, and style
       check-links: true
       check-cross-references: true
       lint-markdown: false
       check-format: false
-      lint-vale: false
+      lint-vale: true
       generate-preview: false
       post-comment: false
       # Don't create issues automatically to avoid flake issues
diff --git a/.github/workflows/docs-unified.yaml b/.github/workflows/docs-unified.yaml
@@ -125,6 +125,8 @@ jobs:
           ./scripts/pnpm_install.sh --prefer-offline || ./scripts/pnpm_install.sh --no-frozen-lockfile
           echo "Node.js dependencies installed successfully"
         
+      # Vale style checking for documentation
+      # This is the ONLY place Vale is actually run - the action in docs-core is a placeholder
       - name: Run Vale style checks
         if: steps.docs-core-setup.outputs.needs_vale == 'true'
         uses: errata-ai/vale-action@v2.1.1
