pipelines

Documentation

Overview

Package pipelines defines the pipeline and the resources.

Index

• type Pipeline
  • func NewPipeline() *Pipeline
  • func (resources *Pipeline) AddStage(stage stages.Stage)
  • func (resources *Pipeline) Build()
  • func (resources *Pipeline) GetStageResult(name string, stageType string) (string, error)
  • func (resources *Pipeline) Size() int
• type Resources
  • func (resources *Resources) ReportStageResult(stage stages.Stage, resultStr string)

Types

type Pipeline

type Pipeline struct {
	Stages list.List
}

Pipeline stores the list of stages.

func NewPipeline

func NewPipeline() *Pipeline

NewPipeline create a new pipeline instance

func (*Pipeline) AddStage

func (resources *Pipeline) AddStage(stage stages.Stage)

AddStage appends specified stage to the pipeline.

func (*Pipeline) Build

func (resources *Pipeline) Build()

Build builds a pipeline for the current resources

func (*Pipeline) GetStageResult

func (resources *Pipeline) GetStageResult(name string, stageType string) (string, error)

GetStageResult returns the result (stdout, stderr, return value) of specified stage.

func (*Pipeline) Size

func (resources *Pipeline) Size() int

Size returns the number of stages in the pipeline.

type Resources

type Resources struct {
	// Pipeline stores the list of stages to be executed.
	Pipeline *Pipeline

	// Cleanup stores the list of stages extecuted after Pipeline.
	Cleanup *Pipeline

	// Reporter stores the messenger client which report the result to the server.
	Reporter messengers.Messenger

	// RepoService is a client of VCS services such as GitHub and reports the result to the service.
	RepoService services.Service
}

Resources stores the settings loaded from the configuation file.

func (*Resources) ReportStageResult

func (resources *Resources) ReportStageResult(stage stages.Stage, resultStr string)

ReportStageResult throw the results of specified stage to the messenger services.