gh

Documentation

Index

• Variables
• type API
  • func (gh *API) GetBranch(location *Location) (*Branch, error)
  • func (gh *API) GetFile(location *Location) (File, error)
  • func (gh *API) GetFileAsync(location *Location) *FileFuture
  • func (gh *API) GetFiles(location *Location) ([]File, error)
  • func (gh *API) GetStatuses(location *Location) ([]github.RepoStatus, error)
• type Branch
• type File
  • func (f *File) Name() string
• type FileFuture
  • func (ff *FileFuture) Get() (File, error)
• type Interface
  • func New(token string, cacheDir string, statsd statsdw.Interface) Interface
• type Location
  • func NewLocation(location string) (*Location, error)
  • func (l *Location) Clean()
  • func (l *Location) Defaults(defaults Location)
  • func (l Location) String() string

Variables

var (
	ContentLocationRE = regexp.MustCompile(`^github.com/([^/]+)/([^/]+)/(.*)$`)
)

Types

type API

type API struct {
	// contains filtered or unexported fields
}

func (*API) GetBranch

func (gh *API) GetBranch(location *Location) (*Branch, error)

func (*API) GetFile

func (gh *API) GetFile(location *Location) (File, error)

func (*API) GetFileAsync

func (gh *API) GetFileAsync(location *Location) *FileFuture

func (*API) GetFiles

func (gh *API) GetFiles(location *Location) ([]File, error)

func (*API) GetStatuses

func (gh *API) GetStatuses(location *Location) ([]github.RepoStatus, error)

type Branch

type Branch struct {
	Location
	github.Rate
	Name, SHA string
	Author    string
	Date      time.Time
	Message   string
}

type File

type File struct {
	Path    string
	Content string
}

func (*File) Name

func (f *File) Name() string

type FileFuture

type FileFuture struct {
	// contains filtered or unexported fields
}

func (*FileFuture) Get

func (ff *FileFuture) Get() (File, error)

type Interface

type Interface interface {
	GetBranch(location *Location) (*Branch, error)
	GetFile(location *Location) (File, error)
	GetFiles(location *Location) ([]File, error)
	GetStatuses(location *Location) ([]github.RepoStatus, error)
}

func New

func New(token string, cacheDir string, statsd statsdw.Interface) Interface

type Location

type Location struct {
	Owner, Repo, Path, Ref string `yaml:",omitempty"`
}

func NewLocation

func NewLocation(location string) (*Location, error)

func (*Location) Clean

func (l *Location) Clean()

func (*Location) Defaults

func (l *Location) Defaults(defaults Location)

func (Location) String

func (l Location) String() string