Checking Specs During PR Review

A pull request in an organization repository has a Governance tab, where reviewers can check the changed API specifications against your rulesets. It gives reviewers the findings to base their decision on.

The check is advisory. Findings don’t block a merge and don’t add a status check to the pull request. Organizations are available on the Team and Enterprise plans.

To make the rulesets a required check, run apigit lint --org <organization> --report-status in CI: it posts the commit status apigit/lint, which a branch protection rule can require before a merge.

Reviewing Governance Results

To see governance results during PR review:

1. Navigate to the PR containing API specification changes
2. Select the Governance tab within the PR interface
3. Select an API specification under Changed Files. The results are shown for one file at a time, for the version in the pull request.
4. Use the ruleset dropdown to switch between rulesets, as in the editor
5. Use these findings to make informed approval decisions

Repeat for each changed spec. A file that isn’t an API specification can’t be analyzed.