You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add SARIF (Static Analysis Results Interchange Format) output support to docvet for integration with GitHub Code Scanning, SonarQube, and future AI-native triage workflows.
Motivation
SARIF is the OASIS standard for static analysis output (v2.1.0). GitHub Code Scanning natively ingests SARIF. Adding SARIF output means:
GitHub Advanced Security can display docvet findings in the Security tab and PR annotations
SonarQube can import SARIF results
AI-native SARIF (emerging concept) embeds prompts and fix guidance in findings for AI agent triage
Lower priority than --format json (#151). SARIF matters once docvet is in CI pipelines. No AI coding agent natively parses SARIF today, but GitHub Code Scanning ingestion makes this valuable for the CI feedback loop.
Summary
Add SARIF (Static Analysis Results Interchange Format) output support to docvet for integration with GitHub Code Scanning, SonarQube, and future AI-native triage workflows.
Motivation
SARIF is the OASIS standard for static analysis output (v2.1.0). GitHub Code Scanning natively ingests SARIF. Adding SARIF output means:
--format json(feat: add --format json structured output for agent consumption #151) — JSON is for agent consumption, SARIF is for CI/CD platform integrationProposed usage
docvet check --format sarif > docvet-results.sarifGitHub Actions integration
Priority
Lower priority than
--format json(#151). SARIF matters once docvet is in CI pipelines. No AI coding agent natively parses SARIF today, but GitHub Code Scanning ingestion makes this valuable for the CI feedback loop.References
Related
--format json— build first, SARIF second)