Build | @atomist/sdm-pack-build

Goal that performs builds: For example using a Maven or NPM Builder implementation

Hierarchy

FulfillableGoalWithRegistrationsAndListeners<BuilderRegistration | ExternalBuildRegistration, BuildListener>
- Build

Implements

Registerable

Index

Constructors

constructor

Methods

Constructors

constructor

new Build(goalDetailsOrUniqueName?: FulfillableGoalDetails | string, ...dependsOn: Goal[]): Build

Overrides FulfillableGoalWithRegistrationsAndListeners.__constructor
- Defined in lib/Build.ts:73
Parameters
- Default value goalDetailsOrUniqueName: FulfillableGoalDetails | string = DefaultGoalNameGenerator.generateName("build")
- Rest ...dependsOn: Goal[]
Returns Build

Properties

callbacks

callbacks: GoalFulfillmentCallback[]

canceledDescription

canceledDescription: string

context

context: GitHubStatusContext

definition

definition: GoalDefinition

definitionOrGoal

definitionOrGoal: PredicatedGoalDefinition | Goal

dependsOn

dependsOn: Goal[]

environment

environment: string

failureDescription

failureDescription: string

fulfillments

fulfillments: Fulfillment[]

goalListeners

goalListeners: GoalExecutionListener[]

inProcessDescription

inProcessDescription: string

listeners

listeners: BuildListener[]

name

name: string

plannedDescription

plannedDescription: string

projectListeners

projectListeners: GoalProjectListenerRegistration[]

registrations

registrations: (BuilderRegistration | ExternalBuildRegistration)[]

requestedDescription

requestedDescription: string

sdm

sdm: SoftwareDeliveryMachine

skippedDescription

skippedDescription: string

stoppedDescription

stoppedDescription: string

successDescription

successDescription: string

uniqueName

uniqueName: string

waitingForApprovalDescription

waitingForApprovalDescription: string

waitingForPreApprovalDescription

waitingForPreApprovalDescription: string

Methods

Protected addFulfillment

addFulfillment(fulfillment: Fulfillment): this

Inherited from FulfillableGoal.addFulfillment
- Defined in node_modules/@atomist/sdm/lib/api/goal/GoalWithFulfillment.d.ts:101
Parameters
- fulfillment: Fulfillment
Returns this

Protected addFulfillmentCallback

addFulfillmentCallback(cb: GoalFulfillmentCallback): this

Inherited from FulfillableGoal.addFulfillmentCallback
- Defined in node_modules/@atomist/sdm/lib/api/goal/GoalWithFulfillment.d.ts:100
Parameters
- cb: GoalFulfillmentCallback
Returns this

handleBuildCompleteEvent

handleBuildCompleteEvent(event: EventFired<Subscription>, context: HandlerContext, goal: Build): Promise<HandlerResult>

- Defined in lib/Build.ts:121
Parameters
- event: EventFired<Subscription>
- context: HandlerContext
- goal: Build
Returns Promise<HandlerResult>

register

Overrides FulfillableGoal.register
- Defined in lib/Build.ts:109
Parameters
- sdm: SoftwareDeliveryMachine
Returns void

with

with(registration: BuilderRegistration | ExternalBuildRegistration): this

Overrides FulfillableGoalWithRegistrations.with
- Defined in lib/Build.ts:88
Parameters
- registration: BuilderRegistration | ExternalBuildRegistration
Returns this

withExecutionListener

withExecutionListener(listener: GoalExecutionListener): this

Inherited from FulfillableGoal.withExecutionListener
- Defined in node_modules/@atomist/sdm/lib/api/goal/GoalWithFulfillment.d.ts:98
Parameters
- listener: GoalExecutionListener
Returns this

withListener

withListener(listener: BuildListener): this

Inherited from FulfillableGoalWithRegistrationsAndListeners.withListener
- Defined in node_modules/@atomist/sdm/lib/api/goal/GoalWithFulfillment.d.ts:121
Parameters
- listener: BuildListener
Returns this

withProjectListener

withProjectListener(listener: GoalProjectListenerRegistration): this

Inherited from FulfillableGoal.withProjectListener
- Defined in node_modules/@atomist/sdm/lib/api/goal/GoalWithFulfillment.d.ts:97
Parameters
- listener: GoalProjectListenerRegistration
Returns this

withService

withService(registration: ServiceRegistration<any>): this

Inherited from FulfillableGoal.withService
- Defined in node_modules/@atomist/sdm/lib/api/goal/GoalWithFulfillment.d.ts:99
Parameters
- registration: ServiceRegistration<any>
Returns this

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value goalDetailsOrUniqueName: FulfillableGoalDetails | string = DefaultGoalNameGenerator.generateName("build")

Rest ...dependsOn: Goal[]

Returns Build

Properties

callbacks

canceledDescription

context

definition

definitionOrGoal

dependsOn

environment

failureDescription

fulfillments

goalListeners

inProcessDescription

listeners

name

plannedDescription

projectListeners

registrations

requestedDescription

sdm

skippedDescription

stoppedDescription

successDescription

uniqueName

waitingForApprovalDescription

waitingForPreApprovalDescription

Methods

Protected addFulfillment

Parameters

fulfillment: Fulfillment

Returns this

Protected addFulfillmentCallback

Parameters

cb: GoalFulfillmentCallback

Returns this

handleBuildCompleteEvent

Parameters

event: EventFired<Subscription>

context: HandlerContext

goal: Build

Returns Promise<HandlerResult>

register

Parameters

sdm: SoftwareDeliveryMachine

Returns void

with

Parameters

registration: BuilderRegistration | ExternalBuildRegistration

Returns this

withExecutionListener

Parameters

listener: GoalExecutionListener

Returns this

withListener

Parameters

listener: BuildListener

Returns this

withProjectListener

Parameters

listener: GoalProjectListenerRegistration

Returns this

withService

Parameters

registration: ServiceRegistration<any>

Returns this