github

Documentation

Overview

Package github is a focused wrapper around `github.com/google/go-github` with methods needed for `blend/require-conditional-status-checks`.

Index

• func GetFile(ctx context.Context, c *github.Client, owner, repo, ref, path string) ([]byte, error)
• func NewClient(ctx context.Context, rootURL, token string) (*github.Client, error)

Functions

func GetFile

func GetFile(ctx context.Context, c *github.Client, owner, repo, ref, path string) ([]byte, error)

GetFile downloads the contents of a file.

func NewClient

func NewClient(ctx context.Context, rootURL, token string) (*github.Client, error)

NewClient creates a new client and determines if it's needed for the public GitHub API or GitHub Enterprise. The `rootURL` is expected to be the value of the `GITHUB_API_URL` environment variable / the `${{ github.api_url }}` context value.