GitHub REST API rules and check runs

GitHub REST API rules and check runs

The README says that GhaRepositoryRuleset and GhaRequiredStatusCheck come from the REST API’s rules and check runs pages at API version 2026-03-10.¹ The rules module’s comment says that its fields follow that version, and that none of the version’s breaking changes touches rulesets, rules or check runs, so they read the same at 2022-11-28.²

The module names each field after the REST field it renders:

• a ruleset’s page, _links.html.href, is ruleset_uri, which the adapt copy replaces with LOKF’s id, and the ruleset’s numeric id becomes ruleset_id;
• source_type, source and target become ruleset_source_type, ruleset_source and ruleset_target, and enforcement keeps its name;
• conditions.ref_name.include and conditions.ref_name.exclude become ref_name_include and ref_name_exclude;
• a bypass actor’s actor_type and bypass_mode keep their names;
• a required check’s required_status_checks[].context becomes check_context, and integration_id, strict_required_status_checks_policy and do_not_enforce_on_create become integration_id, strict_policy and do_not_enforce_on_create.

GhaRepositoryRuleset also cites GitHub’s pages about rulesets and the rules available to them, and GhaRequiredStatusCheck its pages about status checks and about troubleshooting required status checks.

scripts/check_upstream_release.py pins the version as PINNED_API_VERSION and asks GitHub’s API for the list of supported versions on each run. It reports a newer version than the pin, and asks for its breaking changes to be read for changes to rulesets, rules or check runs.³

Footnotes

1. README.md, the What it models section ↩

2. src/github_actions/schema/github_actions_rules.yaml, the module comment and the attribute descriptions ↩

3. scripts/check_upstream_release.py, PINNED_API_VERSION and the end of check() ↩