brigade

Documentation

Index

• type Service
  • func NewService(brigadestore storage.Store) Service

Types

type Service

type Service interface {
	// GetProjectBuilds will get one project.
	GetProject(projectID string) (*brigademodel.Project, error)
	// GetProjectLastBuild will get projects last builds.
	GetProjectLastBuilds(projectID string, quantity int) ([]*brigademodel.Build, error)
	// GetProjects will get all the projects that are on brigade.
	GetProjects() ([]*brigademodel.Project, error)
	// GetBuild will get one build.
	GetBuild(buildID string) (*brigademodel.Build, error)
	// GetProjectBuilds will get all the builds of a project in descendant or ascendant order.
	GetProjectBuilds(project *brigademodel.Project, desc bool) ([]*brigademodel.Build, error)
	// RerunBuild will take a buildID and rerun that build. The build needs to exist
	// if the build doesn't exist it will error.
	RerunBuild(buildID string) error
	// GetBuildJobs will get all the jobs of a build in descendant or ascendant order.
	GetBuildJobs(BuildID string, desc bool) ([]*brigademodel.Job, error)
	// GetJob will get a job.
	GetJob(jobID string) (*brigademodel.Job, error)
	// GetJobLog will get a job log.
	GetJobLog(jobID string) (io.ReadCloser, error)
	// GetJobLogStream will get a job log stream that will be updated when new logs
	// are created, in other words this stream is a real time stream of a job log.
	GetJobLogStream(jobID string) (io.ReadCloser, error)
}

Service is the service where all the brigade data will be retrieved and prepared with the information that this applications needs.

func NewService

func NewService(brigadestore storage.Store) Service

NewService returns a new brigade service.