github

Documentation

Index

• type FileGetter
  • func FileGetterFactory(org, repo, branch string, opts ...Opt) FileGetter
• type Opt
  • func WithAuthentication(username, token string) Opt
• type Opts

Types

type FileGetter

type FileGetter func(path string) ([]byte, error)

FileGetter is a function that downloads the file from the provided path via raw.githubusercontent.com to avoid getting rate limited. It returns a nil error on 404. TODO: Rethink the 404 behavior?

func FileGetterFactory

func FileGetterFactory(org, repo, branch string, opts ...Opt) FileGetter

FileGetterFactory returns a GithubFileGetter that downloads files from raw.githubusercontent.com for the provided org/repo/branch It avoids getting ratelimited by using raw.githubusercontent.com. Because it is using a plain http client it can be heavily paralellized without killing the machine. It supports private repositories when configured WithAuthentication.

type Opt

type Opt func(*Opts)

func WithAuthentication

func WithAuthentication(username, token string) Opt

type Opts

type Opts struct {
	// The username to use for basic auth
	BasicAuthUser string
	// The token to use for basic auth
	BasicAuthPassword string
}