Documentation
¶
Index ¶
Constants ¶
const ( Running BuildStatus = "RUNNING" Success = "SUCCESS" Failure = "FAILURE" Aborted = "ABORTED" )
These are the set of valid statuses that a build can be set to
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API interface {
BuildFromID(buildID string) (Build, error)
JobFromID(jobID string) (Job, error)
PipelineFromID(pipelineID string) (Pipeline, error)
UpdateBuildStatus(status BuildStatus, buildID string) error
PipelineDefFromYaml(yaml io.Reader) (PipelineDef, error)
UpdateStepStart(buildID, stepName string) error
UpdateStepStop(buildID, stepName string, exitCode int) error
SecretsForBuild(build Build) (Secrets, error)
}
API is a Screwdriver API endpoint
type BuildStatus ¶ added in v1.0.23
type BuildStatus string
BuildStatus is the status of a Screwdriver build
func (BuildStatus) String ¶ added in v1.0.30
func (b BuildStatus) String() string
type BuildStatusPayload ¶ added in v1.0.30
type BuildStatusPayload struct {
Status string `json:"status"`
}
BuildStatusPayload is a Screwdriver Build Status payload.
type CommandDef ¶ added in v1.0.26
CommandDef is the definition of a single executable command.
type Emitter ¶ added in v1.0.42
type Emitter interface {
StartCmd(cmd CommandDef)
io.WriteCloser
Error() error
}
Emitter is an io.WriteCloser that knows about CommandDef
func NewEmitter ¶ added in v1.0.42
NewEmitter returns an emitter object from an emitter destination path
type Job ¶ added in v1.0.6
type Job struct {
ID string `json:"id"`
PipelineID string `json:"pipelineId"`
Name string `json:"name"`
}
Job is a Screwdriver Job.
type JobDef ¶ added in v1.0.21
type JobDef struct {
Image string `json:"image"`
Commands []CommandDef `json:"commands"`
Environment map[string]string `json:"environment"`
}
JobDef contains the step and environment definitions of a single Job.
type PipelineDef ¶ added in v1.0.21
type PipelineDef struct {
Jobs map[string][]JobDef `json:"jobs"`
Workflow []string `json:"workflow"`
}
PipelineDef contains the step definitions and jobs for a Pipeline.
type SDError ¶ added in v1.0.15
type SDError struct {
StatusCode int `json:"statusCode"`
Reason string `json:"error"`
Message string `json:"message"`
}
SDError is an error response from the Screwdriver API
type Secrets ¶ added in v1.1.2
type Secrets []Secret
Secrets is the collection of secrets for a Screwdriver build
type StepStartPayload ¶ added in v1.0.45
StepStartPayload is a Screwdriver Step Start payload.
type StepStopPayload ¶ added in v1.0.45
StepStopPayload is a Screwdriver Step Stop payload.