Constructor for both the ServiceListener and ServiceEmitter.
Construction object for either ServiceListener or ServiceEmitter.
Retrieve the Github SDK API handle.
Github SDK handle.
Retrieve the authentication token for Github Service.
Current Github authentication token.
Get the name of the Github service.
The name of the service.
Authenticate against the Github API and Installation environment (for Integrations).
Promise fulfilled once authentication has occurred.
Retrieve configuration file from a Github repository
The location of the configuration file, including repository and file path.
A promise containing a string which is the contents of the configuration file.
Handles all Github events to trigger actions, should the parameters meet those registered.
A ServiceEvent created from the event sent by Github.
Promise that is fulfilled once all processing of the event has completed.
Queue an event ready for running in a child.
The WorkerEvent to add to the queue for processing.
Create a new event triggered action for the list.
A GithubRegistration object detailing the events required by the client.
Remove a worker from a context post-action.
The context in which the Worker must be removed.
Send data to Github.
This method will automatically deal with paged requests. Should any passed data
reference the per_page
or page
properties, these will be honoured, else page
fetches will start at 0 with the default 30 entries per page
Fetches will occur until there are no pages left to fetch.
A ServiceEmitRequest detailling the call to make and associated data.
A ServiceEmitResponse comprised from the response from Github.
Generated using TypeDoc
The Github service allows all interaction with Github. It implements both a ServiceListener that listens to webhooks and a ServiceEmitter that communicates with GH via its API.