Function writeGitHubSummary

scripts/docs-validation/validate.ts:535–579

(
  summaryData: {
    language: string;
    passed: number;
    failed: number;
    failures: ValidationResult[];
  }[],
)

}

function writeGitHubSummary(
  summaryData: {
    language: string;
    passed: number;
    failed: number;
    failures: ValidationResult[];
  }[],
) {
  const summaryFile = process.env.GITHUB_STEP_SUMMARY;
  if (!summaryFile) return;

  const totalPassed = summaryData.reduce((sum, d) => sum + d.passed, 0);
  const totalFailed = summaryData.reduce((sum, d) => sum + d.failed, 0);
  const allPassed = totalFailed === 0;

  let summary = `## 📖 Documentation Validation Results\n\n`;

  if (allPassed) {
    summary += `✅ **All ${totalPassed} code blocks passed validation**\n\n`;
  } else {
    summary += `❌ **${totalFailed} failures** out of ${totalPassed + totalFailed} code blocks\n\n`;
  }

  summary += `| Language | Status | Passed | Failed |\n`;
  summary += `|----------|--------|--------|--------|\n`;

  for (const { language, passed, failed } of summaryData) {
    const status = failed === 0 ? "✅" : "❌";
    summary += `| ${language} | ${status} | ${passed} | ${failed} |\n`;
  }

  if (totalFailed > 0) {
    summary += `\n### Failures\n\n`;
    for (const { language, failures } of summaryData) {
      if (failures.length === 0) continue;
      summary += `#### ${language}\n\n`;
      for (const f of failures) {
        summary += `- **${f.sourceFile}:${f.sourceLine}**\n`;
        summary += `  \`\`\`\n  ${f.errors.slice(0, 3).join("\n  ")}\n  \`\`\`\n`;
      }
    }
  }

  fs.appendFileSync(summaryFile, summary);
}

async function main() {
  const args = process.argv.slice(2);