feat: add ods init command and SARIF report output#14
Merged
Conversation
added 2 commits
May 30, 2026 21:01
- New 'ods init github' command: scaffolds PR template, CI workflows, .ods.yaml - New SARIF v2.1.0 output in ods report (ods-compliance.sarif) - Updated README: stable surface table, dogfooding badge, experimental warning - Updated report test to verify SARIF file generation
Use github.com/open-delivery-spec/spec for badge links, open-delivery-spec.github.io/spec for docs, adoption guide, and SARIF URIs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the two highest-impact CLI improvements:
ods initfor one-command adoption, and SARIF output for CI tool integration.Changes
New:
ods init githubcommandOne-command scaffolding that eliminates the need to read the spec before adopting:
Generates:
.github/PULL_REQUEST_TEMPLATE.md— ODS-compliant PR template.github/workflows/ods-l1.yml— PR validation workflow.github/workflows/ods-commit-message.yml— commit validation workflow.ods.yaml— default enterprise policy configIncludes skip-if-exists logic, next-step instructions, and badge guidance.
New: SARIF v2.1.0 output
ods reportnow generatesods-compliance.sarifalongside HTML, JSON, SVG, and Markdown. SARIF is an OASIS standard supported by GitHub Code Scanning and Azure DevOps. Each result includes rule ID (ODS01/02/03), severity level, and file-level location hints.Modified
Testing
go build ./...✅go test ./...✅ (all packages pass)ods init githubgenerates correct files in empty dirods reportproduces validods-compliance.sarifwith pass and fail scenarios