Known Gap in G2 Check
Current behaviour: G2 awards 10 points if any .github/workflows/*.yml exists — including build, deploy, or test workflows that have nothing to do with API linting.
The problem: A repo with only a deploy.yml workflow passes G2 and gets 10 points, even though no API governance is in place.
Proposed fix: Parse the workflow YAML and check that it references spectral, redocly, api-lint, or similar linting tools before awarding points.
Tradeoff: This makes the check more accurate but also more brittle — a team using a custom linting tool not in the keyword list would fail despite having governance.
Questions:
- Should we check for specific tool names (spectral, redocly) or a more generic pattern?
- Should a partial score (5 pts) be awarded for any CI + full (10 pts) for verified linting CI?
- Should we support non-GitHub CI systems (GitLab, CircleCI, Azure Pipelines)?
See SCORING.md for current rationale.
Known Gap in G2 Check
Current behaviour: G2 awards 10 points if any
.github/workflows/*.ymlexists — including build, deploy, or test workflows that have nothing to do with API linting.The problem: A repo with only a
deploy.ymlworkflow passes G2 and gets 10 points, even though no API governance is in place.Proposed fix: Parse the workflow YAML and check that it references
spectral,redocly,api-lint, or similar linting tools before awarding points.Tradeoff: This makes the check more accurate but also more brittle — a team using a custom linting tool not in the keyword list would fail despite having governance.
Questions:
See SCORING.md for current rationale.