github

Documentation

Index

• Variables
• type ContentSpec
  • func (c ContentSpec) String() string
• type GitHub
  • func NewGitHub(httpClient *http.Client) GitHub
• type Repo
  • func (r Repo) String() string

Variables

var (
	// DefaultClient is the default GitHub client.
	DefaultClient = &defaultGitHub{
		httpClient: defaultHTTPClient(),
		urlParse:   url.Parse,
	}
)

Types

type ContentSpec

type ContentSpec struct {
	Repo
	Path    string // Path within repo to fetch
	RefSpec string // A git refspec - branch, tag, or commit sha1.
}

ContentSpec represents coordinates for fetching contents from a GitHub repo

func (ContentSpec) String

func (c ContentSpec) String() string

type GitHub

type GitHub interface {
	ValidateURL(u string) error
	CommitSHA1(ctx context.Context, repo Repo, refSpec string) (string, error)
	Contents(ctx context.Context, repo Repo, path, sha1 string) (*github.RepositoryContent, []*github.RepositoryContent, error)
}

GitHub is an interface for communicating with GitHub.

func NewGitHub

func NewGitHub(httpClient *http.Client) GitHub

NewGitHub constructs a GitHub client

type Repo

type Repo struct {
	Org  string
	Repo string
}

Repo is a GitHub repo

func (Repo) String

func (r Repo) String() string