GhEx.Checks (gh_ex v0.3.1)

Copy Markdown View Source

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

Types

id()

Functions

create_run(client, owner, repo, attrs, opts \\ [])

Creates a check run.

get_run(client, owner, repo, check_run_id, opts \\ [])

Gets a check run by id.

list_for_ref(client, owner, repo, ref, opts \\ [])

Lists check runs for a git ref.

update_run(client, owner, repo, check_run_id, attrs, opts \\ [])

Updates a check run.

Types

id()

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

Functions

create_run(client, owner, repo, attrs, opts \\ [])

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

Creates a check run.

get_run(client, owner, repo, check_run_id, opts \\ [])

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

Gets a check run by id.

list_for_ref(client, owner, repo, ref, opts \\ [])

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

Lists check runs for a git ref.

update_run(client, owner, repo, check_run_id, attrs, opts \\ [])

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

Updates a check run.