Switch developer guide linting to asciidoctor-lint

Author: shai-almog

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

@@ -82,41 +82,28 @@ jobs:
         with:
           ruby-version: '3.1'
 
-      - name: Set up Java for docToolchain
-        uses: actions/setup-java@v4
-        with:
-          distribution: temurin
-          java-version: '17'
-
       - name: Install Asciidoctor tooling
         run: |
-          gem install --no-document asciidoctor asciidoctor-pdf
+          gem install --no-document asciidoctor asciidoctor-pdf asciidoctor-lint
 
-      - name: Download docToolchain
-        run: |
-          set -euo pipefail
-          DT_VERSION="3.4.2"
-          DT_ROOT="${RUNNER_TEMP}/doctoolchain"
-          mkdir -p "$DT_ROOT"
-          curl -fsSL -o "$DT_ROOT/doctoolchain.zip" "https://github.com/docToolchain/docToolchain/releases/download/v${DT_VERSION}/docToolchain-${DT_VERSION}.zip"
-          unzip -q "$DT_ROOT/doctoolchain.zip" -d "$DT_ROOT"
-          DOC_TOOLCHAIN_HOME="$DT_ROOT/docToolchain-${DT_VERSION}"
-          echo "DOC_TOOLCHAIN_HOME=$DOC_TOOLCHAIN_HOME" >> "$GITHUB_ENV"
-
-      - name: Run docToolchain AsciiDoc linter
+      - name: Run Asciidoctor lint
         run: |
           set -euo pipefail
           REPORT_DIR="build/developer-guide/reports"
           REPORT_FILE="${REPORT_DIR}/asciidoc-lint-report.txt"
           mkdir -p "$REPORT_DIR"
+          if ! command -v asciidoctor-lint >/dev/null 2>&1; then
+            echo "asciidoctor-lint is not available" >&2
+            exit 1
+          fi
           set +e
-          "$DOC_TOOLCHAIN_HOME/bin/doctoolchain" docs/developer-guide asciidocLint | tee "$REPORT_FILE"
+          asciidoctor-lint docs/developer-guide/developer-guide.asciidoc | tee "$REPORT_FILE"
           STATUS=${PIPESTATUS[0]}
           set -e
           echo "ASCII_DOC_LINT_REPORT=$REPORT_FILE" >> "$GITHUB_ENV"
           echo "ASCII_DOC_LINT_STATUS=$STATUS" >> "$GITHUB_ENV"
           if [ "$STATUS" -ne 0 ]; then
-            echo "docToolchain AsciiDoc linter exited with status $STATUS" >&2
+            echo "asciidoctor-lint exited with status $STATUS" >&2
           fi
 
       - name: Build Developer Guide HTML and PDF

scripts/developer-guide/summarize_reports.py

@@ -79,10 +79,30 @@ def summarize_asciidoc(report: Path, status: str, summary_key: str, output: Path
     text = ""
     if report.is_file():
         text = report.read_text(encoding="utf-8", errors="ignore")
-    issues = re.findall(r"\b(?:WARN|ERROR|SEVERE)\b", text)
 
-    if issues:
-        summary = f"{len(issues)} issue(s) flagged"
+    pattern = re.compile(r"^\s*[^:\n]+:\d+:\d+:\s+(ERROR|WARN(?:ING)?|INFO)\b", re.MULTILINE)
+    matches = pattern.findall(text)
+
+    counts = {"error": 0, "warning": 0, "info": 0}
+    for severity in matches:
+        normalized = severity.upper()
+        if normalized == "ERROR":
+            counts["error"] += 1
+        elif normalized in {"WARN", "WARNING"}:
+            counts["warning"] += 1
+        elif normalized == "INFO":
+            counts["info"] += 1
+
+    total = sum(counts.values())
+
+    if total:
+        parts = [f"{counts['error']} errors"] if counts["error"] else []
+        if counts["warning"]:
+            parts.append(f"{counts['warning']} warnings")
+        if counts["info"]:
+            parts.append(f"{counts['info']} info")
+        detail = f" ({', '.join(parts)})" if parts else ""
+        summary = f"{total} issue(s) flagged{detail}"
         if _has_nonzero_status(status):
             summary += f" (exit code {_normalize_status(status)})"
     elif _has_nonzero_status(status):
@@ -162,7 +182,7 @@ def summarize_unused_images(
 
     output_lines = [f"{summary_key}={summary}"]
     if details_key and lines:
-        details_value = "\\n".join(lines)
+        details_value = "\n".join(lines)
         output_lines.append(f"{details_key}={details_value}")
 
     write_output(output_lines, output)