github

Documentation

Overview

Package github holds utilities for bootstrapping a Github API client from the metadata injected by the GithubBinding. Within a process running in the context of a GithubBinding, users can write:

client, err := github.New(ctx)

to get a client authorized with the access token from the GithubBinding.

Index

• Constants
• func AccessToken() (string, error)
• func New(ctx context.Context) (*github.Client, error)
• func ReadKey(key string) (string, error)

Constants

const (
	VolumeName = "github-binding"
	MountPath  = bindings.MountPath + "/github" // filepath.Join isn't const.
)

Functions

func AccessToken

func AccessToken() (string, error)

AccessToken reads the file named accessToken that is mounted by the GithubBinding.

func New

func New(ctx context.Context) (*github.Client, error)

New instantiates a new github client from the access token from the GithubBinding

func ReadKey

func ReadKey(key string) (string, error)

ReadKey may be used to read keys from the secret bound by the GithubBinding.