@spec app(atom()) :: GitHub.App.t() | nil

Constructs a GitHub.App struct using information from configuration

This is a convenience function for creating GitHub.App structs that are compatible with the GitHub.Auth protocol for authenticating requests. It accepts the name of a GitHub App that is configured using the apps key:

iex> app = GitHub.app(:my_app)
%GitHub.App{id: 12345, pem: ""-----BEGIN RSA PRIVATE KEY..."}

iex> GitHub.Apps.get_installation(67890, auth: app)
{:ok, %GitHub.Installation{...}}

It is common (and strongly recommended) to use environment variables and runtime configuration for the app ID and private key.

configuration

Configuration

App configs are always given as 3-tuples containing a configuration name for the app (atom), the app's ID (integer), and the app's private key (string, PEM formatted).

config :oapi_config,
  apps: [
    {:my_app, 12345, ""-----BEGIN RSA PRIVATE KEY..."}
  ]

caching

Caching

JWTs are designed to last for several minutes.

@spec raw(module(), atom(), [any()], keyword()) ::
  {:ok, GitHub.Operation.t()} | {:error, GitHub.Error.t()}

Run a client operation and return the raw Operation or Error

Normal client operation calls return only the response body. This function can be useful when the caller needs additional information, such as data from the response headers.

The args passed to this function should not include the opts argument usually available on client operations. Instead, any such options should be passed as the final argument to raw/4.

example

Example

iex> GitHub.raw(GitHub.Users, :get_authenticated, [])
{:ok, %GitHub.Operation{}}