Custodian v0.0.1 API Reference

Modules

Custodian is a GitHub bot to manage routine development tasks. At a high-level it attempts to do the following

The Bots context provides a boundary into the Custodian.Bots.Bot schema. It provides functions for listing, creating, updating, and deleting bots

A Bot is installed on an individual repo on GitHub. It holds data about its repo and installation

The GitHub context provides a boundary into the GitHub API client interface and associated domain logic. The top-level class provides a way to process webhook payloads from GitHub

Behaviour interface for taking actions on specific repos on GitHub

Behaviour interface for interacting with labels on pull requests on GitHub

Behaviour interface for merging branches on GitHub

Processing functions for each type of event from GitHub’s webhook that we respond to

Behaviour interface for interacting with branches on GitHub

Provides an implementation of the Custodian.Github.Client behaviour with the GitHub API

Provides an implementation of the Custodian.Github.Labels behaviour with the GitHub API

Provides an implementation of the Custodian.Github.Merges behaviour with the GitHub API

Provides an implementation of the Custodian.Github.References behaviour with the GitHub API

Behaviour interface for processing tasks

Provides an implmenetation of the Custodian.Tasks behaviour

Provides an implmenetation of the Custodian.Tasks behaviour

The entrypoint for defining your web interface, such as controllers, views, channels and so on

Translates controller action results into valid Plug.Conn responses

Module with named helpers generated from CustodianWeb.Router

Responds to the GitHub webhook and sends the payload for processing