github

package

v0.1.1 Latest Latest Go to latest Published: Feb 11, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

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.

This section is empty.

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

Provider implements the Provider interface for GitHub

func NewProvider(ctx context.Context, token, baseURL string, orgs []string) (p Provider, err error)

NewProvider returns a new Provider with a new GitHub client instanciation and associated config

func (p Provider) Compare(project string, fromRef, toRef providers.Ref) (cmp *providers.Comparison, err error)

Compare calculates the diff between two git references

func (p Provider) ListRefs(project string) (refs providers.Refs, err error)

ListRefs returns all the Refs for a given project

func (p Provider) ListRepositories() (repos providers.Repositories, err error)

ListRepositories returns the list of all projects which belong to the organizations configured

func (p Provider) ListRepositoryBranches(owner, repo string) (refs providers.Refs, err error)

ListRepositoryBranches returns all the branches for a given repository

func (p *Provider) ListRepositoryTags(owner, repo string) (refs providers.Refs, err error)

ListRepositoryTags returns all the tags for a given repository

func (p Provider) Type() providers.ProviderType

Type returns the provider type

func (p Provider) WebBaseURL() string

WebBaseURL returns the base URL for HTML rendered pages (non-API)