github

Documentation

Index

• func Factory(ctx context.Context, conf *project.BackendConfig) (project.Backend, error)
• type Backend
  • func (b *Backend) LocalLocation() string
  • func (b *Backend) Name() string
  • func (b *Backend) RetrievalFunc() retrieval.Backend
  • func (b *Backend) SetLocalLocation(l string) project.Backend
  • func (b *Backend) SourceLocation() string
  • func (b *Backend) Version() string

Functions

func Factory

func Factory(ctx context.Context, conf *project.BackendConfig) (project.Backend, error)

Factory is a function for creating GitHub projects.

Types

type Backend

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

Backend is a GitHub project backend.

func (*Backend) LocalLocation

func (b *Backend) LocalLocation() string

LocalLocation is the location on disk or where the project can be found in order to perform and evaluation or analysis of the project.

func (*Backend) Name

func (b *Backend) Name() string

Name returns the name associated with a GitHub project.

func (*Backend) RetrievalFunc

func (b *Backend) RetrievalFunc() retrieval.Backend

RetrievalFunc is the retrieval function that should be used to retrieve the project from GitHub. An example retrieval function could be Git.

func (*Backend) SetLocalLocation

func (b *Backend) SetLocalLocation(l string) project.Backend

SetLocalLocation sets the local or on-disk location.

func (*Backend) SourceLocation

func (b *Backend) SourceLocation() string

SourceLocation is the source location, i.e., where the project was discovered (e.g., GitHub).

func (*Backend) Version

func (b *Backend) Version() string

Version returns the version of the observed GitHub project (e.g., commit hash, semantic version, etc.).