git

package

v2.0.0+incompatible Latest Latest Go to latest Published: Feb 27, 2017 License: Apache-2.0 Imports: 4 Imported by: 9

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Branches() ([]string, error)

Branches returns a list of branches for the repository

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

Contents returns the contents of the file at the given path

func InitGithub(config *GithubConfig)

InitGithub initializes the github git service with the given config

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

List returns a list of subpaths of the given directory path

type GithubConfig struct {
	Token string
	Owner string
	Repo  string
}

GithubConfig is the configuration for the github client

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