pkg

Documentation

Index

• type Pipeline
  • func (p *Pipeline) AssembleStep() error
  • func (p *Pipeline) Cleanup()
  • func (p *Pipeline) CompileStep() error
  • func (p *Pipeline) DependenciesStep() error
  • func (p *Pipeline) DistStep() error
  • func (p *Pipeline) PackageStep() error
  • func (p *Pipeline) ParseRepoConfig() error
  • func (p *Pipeline) PipelineInitStep() error
  • func (p *Pipeline) RunHook(hookKey string) error
  • func (p *Pipeline) ScmCheckoutPullRequestStep(payload *scm.Payload) error
  • func (p *Pipeline) ScmCheckoutPushPayloadStep(payload *scm.Payload) error
  • func (p *Pipeline) ScmCleanupStep() error
  • func (p *Pipeline) ScmPublishStep() error
  • func (p *Pipeline) ScmRetrievePayloadStep() (*scm.Payload, error)
  • func (p *Pipeline) Start(config config.Interface) error
  • func (p *Pipeline) StepExecNotify(step string, callback func() error) error
  • func (p *Pipeline) TestStep() error
  • func (p *Pipeline) ValidateTools() error

Types

type Pipeline

type Pipeline struct {
	Data   *pipeline.Data
	Config config.Interface
	Scm    scm.Interface
	Engine engine.Interface
}

func (*Pipeline) AssembleStep

func (p *Pipeline) AssembleStep() error

now that the payload has been processed we can begin by building the code. this may be creating missing files/default structure, compilation, version bumping, etc.

func (*Pipeline) Cleanup

func (p *Pipeline) Cleanup()

func (*Pipeline) CompileStep

func (p *Pipeline) CompileStep() error

this step should compile source

func (*Pipeline) DependenciesStep

func (p *Pipeline) DependenciesStep() error

this step should download dependencies

func (*Pipeline) DistStep

func (p *Pipeline) DistStep() error

this step should push the release to the package repository (ie. npm, chef supermarket, rubygems)

func (*Pipeline) PackageStep

func (p *Pipeline) PackageStep() error

this step should commit any local changes and create a git tag. It should also generate the releaser artifacts. Nothing should be pushed to remote repository

func (*Pipeline) ParseRepoConfig

func (p *Pipeline) ParseRepoConfig() error

func (*Pipeline) PipelineInitStep

func (p *Pipeline) PipelineInitStep() error

func (*Pipeline) RunHook

func (p *Pipeline) RunHook(hookKey string) error

func (*Pipeline) ScmCheckoutPullRequestStep

func (p *Pipeline) ScmCheckoutPullRequestStep(payload *scm.Payload) error

func (*Pipeline) ScmCheckoutPushPayloadStep

func (p *Pipeline) ScmCheckoutPushPayloadStep(payload *scm.Payload) error

func (*Pipeline) ScmCleanupStep

func (p *Pipeline) ScmCleanupStep() error

func (*Pipeline) ScmPublishStep

func (p *Pipeline) ScmPublishStep() error

func (*Pipeline) ScmRetrievePayloadStep

func (p *Pipeline) ScmRetrievePayloadStep() (*scm.Payload, error)

func (*Pipeline) Start

func (p *Pipeline) Start(config config.Interface) error

func (*Pipeline) StepExecNotify

func (p *Pipeline) StepExecNotify(step string, callback func() error) error

func (*Pipeline) TestStep

func (p *Pipeline) TestStep() error

run the package test runner(s) (eg. npm test, rake test, kitchen test) and linters/formatters

func (*Pipeline) ValidateTools

func (p *Pipeline) ValidateTools() error

validate that required executables are available for the following build/test/package/etc steps