Custodian

v0.0.1

Custodian v0.0.1 Custodian.Github.Client behaviour View Source

Behaviour interface for taking actions on specific repos on GitHub.

Implemented using Tentacat in Custodian.Github.Tentacat.Client. In tests, implemented as a mock in Mockcat.

Link to this section Summary

Callbacks

app()

Uses the configured private key to generate a JWT

installation(installation_id)

Uses the app JWT to generate an access token

Link to this section Callbacks

Link to this callback app() View Source 
app() :: struct()

Uses the configured private key to generate a JWT.

In development, the key is loaded from config/github_key.pem. In test, it’s loaded from test/support/github_key.pem. In production this is loaded from the GITHUB_API_KEY ENV var.

This token is used to generate access tokens that can be used for repo actions. The JWT can only be used for generating new tokens.

Link to this callback installation(installation_id) View Source 
installation(installation_id :: integer()) :: struct()

Uses the app JWT to generate an access token.

This token can be used to take action on specific repos.