fix: align Vale style checking with parent workflow installation

EdwardAngert · claude · EdwardAngert · commit 96c8b1cb8f40 · 2025-04-24T13:15:09.000-04:00
- Change Vale checking to rely on the parent workflow's installed Vale - Implement chunked processing to handle larger file sets - Improve error handling and logging for Vale processing - Add better output formatting and validation 🤖 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
@@ -701,7 +701,7 @@ runs:
         echo "message=Link checking is enabled" >> $GITHUB_OUTPUT
         echo "::endgroup::"
         
-    # Use Vale GitHub Action for style checking - a more reliable approach
+    # Vale style checking - rely on the Vale installed in the parent workflow
     - name: Run Vale style checks
       id: lint-vale
       if: env.lint_vale == 'true' && steps.file-detection.outputs.has_changes == 'true'
@@ -732,39 +732,114 @@ runs:
           exit 0
         fi
         
-        echo "Creating a file list for Vale to process"
+        echo "Found markdown files to check with Vale"
         FILE_COUNT=$(echo "$FILES_TO_CHECK" | wc -w | tr -d ' ')
         echo "Found $FILE_COUNT markdown files to check"
         
-        # Create file with list of files to check
+        # Verify Vale is available (should be installed by the parent workflow)
+        if ! command -v vale &> /dev/null; then
+          echo "Vale command not found, it should be installed by the parent workflow"
+          echo "status=skipped" >> $GITHUB_OUTPUT
+          echo "message=Vale not installed" >> $GITHUB_OUTPUT
+          echo "::endgroup::"
+          exit 0
+        fi
+        
+        # Show Vale version
+        echo "Using Vale version:"
+        vale --version
+        
+        echo "Running Vale checks on $FILE_COUNT files..."
+        
+        # Create a temporary directory for results
         TEMP_DIR=$(mktemp -d)
-        FILE_LIST="$TEMP_DIR/files_to_check.txt"
-        echo "$FILES_TO_CHECK" | tr ' ' '\n' > "$FILE_LIST"
-        
-        # Run Vale via GitHub CLI Action run - this is a reliable way
-        # to run the Vale Action without needing to install Vale directly
-        echo "Using GitHub CLI to run Vale Action"
-        
-        # Create a workflow using the Vale Action that will analyze the files
-        cat > "$TEMP_DIR/vale-workflow.yml" << EOF
-        name: Vale Validation
-        on: workflow_dispatch
-        jobs:
-          vale:
-            name: Vale
-            runs-on: ubuntu-latest
-            steps:
-              - uses: actions/checkout@v3
-              - uses: errata-ai/vale-action@reviewdog
-                with:
-                  files: \$(cat $FILE_LIST)
-                  fail_on_error: false
-                  reporter: github-check
-        EOF
+        trap 'rm -rf "$TEMP_DIR"' EXIT
+        
+        # Run Vale on files in chunks (to avoid command line length limits)
+        # Create chunks of files (maximum 10 files per chunk)
+        CHUNK_SIZE=10
+        CHUNKS=()
+        CHUNK=""
+        COUNT=0
+        
+        for FILE in $FILES_TO_CHECK; do
+          if [ $COUNT -eq $CHUNK_SIZE ]; then
+            CHUNKS+=("$CHUNK")
+            CHUNK="$FILE"
+            COUNT=1
+          else
+            CHUNK="$CHUNK $FILE"
+            COUNT=$((COUNT + 1))
+          fi
+        done
         
-        echo "Vale check skipped in composite action context"
-        echo "status=success" >> $GITHUB_OUTPUT
-        echo "message=Style checking is available (processed $FILE_COUNT files)" >> $GITHUB_OUTPUT
+        # Add the last chunk if not empty
+        if [ -n "$CHUNK" ]; then
+          CHUNKS+=("$CHUNK")
+        fi
+        
+        # Process each chunk and combine results
+        echo "[" > "$TEMP_DIR/combined_results.json"
+        FIRST_CHUNK=true
+        
+        for ((i=0; i<${#CHUNKS[@]}; i++)); do
+          CHUNK_FILES="${CHUNKS[$i]}"
+          CHUNK_OUTPUT="$TEMP_DIR/chunk_$i.json"
+          
+          echo "Processing chunk $((i+1))/${#CHUNKS[@]} ($(echo "$CHUNK_FILES" | wc -w | tr -d ' ') files)"
+          
+          # Run Vale on this chunk of files
+          vale --no-exit --output=JSON --config=.github/docs/vale/.vale.ini $CHUNK_FILES > "$CHUNK_OUTPUT" 2>/dev/null || true
+          
+          # Verify JSON output and append to combined results
+          if [ -s "$CHUNK_OUTPUT" ] && jq empty "$CHUNK_OUTPUT" 2>/dev/null; then
+            # Add separator between chunks if not first chunk
+            if [ "$FIRST_CHUNK" = true ]; then
+              FIRST_CHUNK=false
+            elif [ -s "$CHUNK_OUTPUT" ]; then
+              echo "," >> "$TEMP_DIR/combined_results.json"
+            fi
+            
+            # Add content without brackets
+            jq -c '.[]' "$CHUNK_OUTPUT" >> "$TEMP_DIR/combined_results.json" || echo "Error processing chunk $i"
+          else
+            echo "No valid results from chunk $i"
+          fi
+        done
+        
+        # Close the combined JSON array
+        echo "]" >> "$TEMP_DIR/combined_results.json"
+        
+        # Fix JSON if needed
+        if ! jq empty "$TEMP_DIR/combined_results.json" 2>/dev/null; then
+          echo "Warning: Invalid combined JSON output, creating empty array"
+          echo "[]" > "$TEMP_DIR/combined_results.json"
+        fi
+        
+        # Extract and analyze results
+        VALE_OUTPUT=$(cat "$TEMP_DIR/combined_results.json")
+        
+        # Store results
+        if [ "$VALE_OUTPUT" = "[]" ] || [ "$(echo "$VALE_OUTPUT" | jq 'length')" -eq 0 ]; then
+          echo "Vale check passed: No style issues found"
+          echo "status=success" >> $GITHUB_OUTPUT
+          echo "message=No style issues found in $FILE_COUNT files" >> $GITHUB_OUTPUT
+        else
+          # Count issues
+          ISSUE_COUNT=$(echo "$VALE_OUTPUT" | jq 'length')
+          echo "Vale found $ISSUE_COUNT style issues in $FILE_COUNT files"
+          
+          # Group issues by file for better readability
+          echo "$VALE_OUTPUT" | jq -r 'group_by(.Path) | .[] | .[0].Path + ":" + (. | length | tostring) + " issues"'
+          
+          # Show details of first 10 issues
+          echo "First 10 issues (detail):"
+          echo "$VALE_OUTPUT" | jq -r '.[] | "\(.Path):\(.Line):\(.Column) - \(.Message) (\(.Check))"' | head -10
+          
+          echo "status=warning" >> $GITHUB_OUTPUT
+          echo "message=Found $ISSUE_COUNT style issues in $FILE_COUNT files" >> $GITHUB_OUTPUT
+          echo "issues=$VALE_OUTPUT" >> $GITHUB_OUTPUT
+        fi
         
         echo "::endgroup::"
         
