GhEx.Checks (gh_ex v0.3.2)

Convenience functions for the GitHub Checks REST API.

Thin wrappers over GhEx.REST that return the same {:ok, body, meta} / {:error, reason} shape; opts pass through to Req.

Summary

id()

Creates a check run.

Gets a check run by id.

Lists check runs for a git ref.

Auto-paginates the check runs for a git ref into a lazy Stream, unwrapping the "check_runs" array on each page (see GhEx.REST.stream/3).

Updates a check run.

@type id() :: integer() | String.t()

@spec create_run(GhEx.Client.t(), String.t(), String.t(), map(), keyword()) ::
  GhEx.REST.result()

Creates a check run.

@spec get_run(GhEx.Client.t(), String.t(), String.t(), id(), keyword()) ::
  GhEx.REST.result()

Gets a check run by id.

@spec list_for_ref(GhEx.Client.t(), String.t(), String.t(), String.t(), keyword()) ::
  GhEx.REST.result()

Lists check runs for a git ref.

@spec stream_for_ref(GhEx.Client.t(), String.t(), String.t(), String.t(), keyword()) ::
  Enumerable.t()

Auto-paginates the check runs for a git ref into a lazy Stream, unwrapping the "check_runs" array on each page (see GhEx.REST.stream/3).

@spec update_run(GhEx.Client.t(), String.t(), String.t(), id(), map(), keyword()) ::
  GhEx.REST.result()

Updates a check run.