git

Documentation

Index

• func Branches() ([]string, error)
• func Contents(branch, path string) ([]byte, error)
• func InitGithub(config *GithubConfig)
• func List(branch, path string) ([]string, error)
• type GithubConfig
• type Service

Functions

func Branches

func Branches() ([]string, error)

Branches returns a list of branches for the repository

func Contents

func Contents(branch, path string) ([]byte, error)

Contents returns the contents of the file at the given path

func InitGithub

func InitGithub(config *GithubConfig)

InitGithub initializes the github git service with the given config

func List

func List(branch, path string) ([]string, error)

List returns a list of subpaths of the given directory path

Types

type GithubConfig

type GithubConfig struct {
	Token string
	Owner string
	Repo  string
}

GithubConfig is the configuration for the github client

type Service

type Service interface {
	Branches() ([]string, error)
	Contents(branch, path string) ([]byte, error)
	List(branch, path string) ([]string, error)
}

Service is a git service that allows for querying and retrieving content from a repository