Handle non-zero Vale exit status

Author: shai-almog

.github/workflows/developer-guide-docs.yml

@@ -189,8 +189,15 @@ jobs:
           REPORT_DIR="build/developer-guide/reports"
           REPORT_FILE="${REPORT_DIR}/vale-report.json"
           mkdir -p "$REPORT_DIR"
+          set +e
           vale --config docs/developer-guide/.vale.ini --output=JSON docs/developer-guide > "$REPORT_FILE"
+          STATUS=$?
+          set -e
           echo "VALE_REPORT=$REPORT_FILE" >> "$GITHUB_ENV"
+          echo "VALE_STATUS=$STATUS" >> "$GITHUB_ENV"
+          if [ "$STATUS" -ne 0 ]; then
+            echo "Vale exited with status $STATUS" >&2
+          fi
 
       - name: Check for unused developer guide images
         run: |
@@ -216,6 +223,7 @@ jobs:
         run: |
           python3 scripts/developer-guide/summarize_reports.py vale \
             --report "${VALE_REPORT}" \
+            --status "${VALE_STATUS:-0}" \
             --output "${GITHUB_OUTPUT}"
 
       - name: Summarize unused image findings

scripts/developer-guide/summarize_reports.py

@@ -32,7 +32,9 @@ def summarize_asciidoc(report: Path, status: str, summary_key: str, output: Path
     write_output([f"{summary_key}={summary}"], output)
 
 
-def summarize_vale(report: Path, summary_key: str, output: Path | None) -> None:
+def summarize_vale(
+    report: Path, status: str, summary_key: str, output: Path | None
+) -> None:
     alerts: list[dict[str, object]] = []
     if report.is_file():
         try:
@@ -61,6 +63,10 @@ def summarize_vale(report: Path, summary_key: str, output: Path | None) -> None:
     else:
         summary = "No alerts found"
 
+    status = status.strip()
+    if status and status != "0":
+        summary += f" (exit code {status})"
+
     write_output([f"{summary_key}={summary}"], output)
 
 
@@ -124,6 +130,7 @@ def parse_args() -> argparse.Namespace:
         help="Summarize Vale style linter results.",
     )
     vale_parser.add_argument("--report", type=Path, required=True)
+    vale_parser.add_argument("--status", default="0")
     vale_parser.add_argument("--summary-key", default="summary")
 
     unused_parser = subparsers.add_parser(
@@ -145,7 +152,7 @@ def main() -> None:
     if command == "ascii":
         summarize_asciidoc(args.report, args.status, args.summary_key, output)
     elif command == "vale":
-        summarize_vale(args.report, args.summary_key, output)
+        summarize_vale(args.report, args.status, args.summary_key, output)
     elif command == "unused-images":
         summarize_unused_images(
             args.report,