Taskcluster GitHub API Documentation

##

The github service, typically available at github.taskcluster.net, is responsible for publishing pulse messages in response to GitHub events.

This document describes the API end-point for consuming GitHub web hooks, as well as some useful consumer APIs.

When Github forbids an action, this service returns an HTTP 403 with code ForbiddenByGithub.

Github Client

// Create Github client instance with default baseUrl:
// https://github.taskcluster.net/v1

const github = new taskcluster.Github(options);

Methods in Github Client

// github.githubWebHookConsumer :: () -> Promise Nothing
github.githubWebHookConsumer()
// github.builds :: [options] -> Promise Result
github.builds()
github.builds(options)
// github.badge :: (owner -> repo -> branch) -> Promise Nothing
github.badge(owner, repo, branch)
// github.repository :: (owner -> repo) -> Promise Result
github.repository(owner, repo)
// github.latest :: (owner -> repo -> branch) -> Promise Nothing
github.latest(owner, repo, branch)
// github.createStatus :: (owner -> repo -> sha -> payload) -> Promise Nothing
github.createStatus(owner, repo, sha, payload)
// github.createComment :: (owner -> repo -> number -> payload) -> Promise Nothing
github.createComment(owner, repo, number, payload)
// github.ping :: () -> Promise Nothing
github.ping()