Skip to content

Add Checks API functions (check runs and check suites) [Changelog 2018-05-16] #617

Description

Summary

The Checks API (check runs and check suites) has no coverage in this module — there is no Checks command category under src/functions/public/. This API is core to surfacing CI/lint/test results against commits and is widely used by GitHub App integrations. The module already supports GitHub App authentication, so Checks is a natural fit.

Changelog reference

  • 2018-05-16Introducing the Checks API: public REST API for building CI, linting, and acceptance-testing tools on GitHub via check runs and check suites, with rich annotations on commits.

Desired capability

Add functions to create and read checks against commits:

  • New-GitHubCheckRun / Set-GitHubCheckRun (update) — create/update a check run with status, conclusion, output, and annotations.
  • Get-GitHubCheckRun — get a check run by ID, or list check runs for a ref/check suite.
  • Get-GitHubCheckSuite — get a check suite by ID, or list check suites for a ref.
  • New-GitHubCheckSuite — create a check suite (and request a run).
  • Set-GitHubCheckSuitePreference — configure auto-trigger preferences.
  • Start-GitHubCheckSuiteRerequest — re-request a check suite.

Acceptance criteria

  • Functions use Invoke-GitHubAPI and the active GitHubContext.
  • Check run creation supports output (title/summary/text), annotations, images, and actions.
  • Typed output objects with default formats for check runs/suites.
  • Integration tests against an owned test repo (App context where required).

Notes

  • Creating check runs requires a GitHub App context with checks: write; reading is available to apps and users with appropriate access.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions