GhEx.Statuses (gh_ex v0.3.3)

Copy Markdown View Source

Convenience functions for the GitHub commit statuses REST API.

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

Summary

Functions

create(client, owner, repo, sha, attrs, opts \\ [])

Creates a commit status.

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

Gets the combined status for a git ref.

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

Lists statuses for a git ref.

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

Auto-paginates the statuses for a git ref into a lazy Stream (see GhEx.REST.stream/3).

Functions

create(client, owner, repo, sha, attrs, opts \\ [])

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

Creates a commit status.

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

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

Gets the combined status for a git ref.

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 statuses for a git ref.

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

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

Auto-paginates the statuses for a git ref into a lazy Stream (see GhEx.REST.stream/3).