Class Release

Class that abstracts creating a release for a project.

Hierarchy

FulfillableGoal
- Release

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Release(detailsOrUniqueName?: FulfillableGoalDetails | string, ...dependsOn: Goal[]): Release

Overrides FulfillableGoal.constructor
- Defined in lib/pack/version/release.ts:73
Parameters
- Default value detailsOrUniqueName: FulfillableGoalDetails | string = DefaultGoalNameGenerator.generateName("release")
- Rest ...dependsOn: Goal[]
Returns Release

Properties

Readonly callbacks

callbacks: GoalFulfillmentCallback[] = []

Readonly context

context: GitHubStatusContext

Readonly definition

definition: GoalDefinition

definitionOrGoal

definitionOrGoal: PredicatedGoalDefinition | Goal

Readonly dependsOn

dependsOn: Goal[]

Readonly fulfillments

fulfillments: Fulfillment[] = []

Readonly goalListeners

goalListeners: GoalExecutionListener[] = []

Readonly projectListeners

projectListeners: GoalProjectListenerRegistration[] = []

sdm

sdm: SoftwareDeliveryMachine

Accessors

canceledDescription

get canceledDescription(): string

Inherited from Goal.canceledDescription
- Defined in lib/api/goal/Goal.ts:101
Returns string

environment

get environment(): string

Inherited from Goal.environment
- Defined in lib/api/goal/Goal.ts:69
Returns string

failureDescription

get failureDescription(): string

Inherited from Goal.failureDescription
- Defined in lib/api/goal/Goal.ts:81
Returns string

inProcessDescription

get inProcessDescription(): string

Inherited from Goal.inProcessDescription
- Defined in lib/api/goal/Goal.ts:77
Returns string

name

get name(): string

Inherited from Goal.name
- Defined in lib/api/goal/Goal.ts:113
Returns string

plannedDescription

get plannedDescription(): string

Inherited from Goal.plannedDescription
- Defined in lib/api/goal/Goal.ts:85
Returns string

requestedDescription

get requestedDescription(): string

Inherited from Goal.requestedDescription
- Defined in lib/api/goal/Goal.ts:89
Returns string

skippedDescription

get skippedDescription(): string

Inherited from Goal.skippedDescription
- Defined in lib/api/goal/Goal.ts:109
Returns string

stoppedDescription

get stoppedDescription(): string

Inherited from Goal.stoppedDescription
- Defined in lib/api/goal/Goal.ts:105
Returns string

successDescription

get successDescription(): string

Inherited from Goal.successDescription
- Defined in lib/api/goal/Goal.ts:73
Returns string

uniqueName

get uniqueName(): string

Inherited from Goal.uniqueName
- Defined in lib/api/goal/Goal.ts:117
Returns string

waitingForApprovalDescription

get waitingForApprovalDescription(): string

Inherited from Goal.waitingForApprovalDescription
- Defined in lib/api/goal/Goal.ts:93
Returns string

waitingForPreApprovalDescription

get waitingForPreApprovalDescription(): string

Inherited from Goal.waitingForPreApprovalDescription
- Defined in lib/api/goal/Goal.ts:97
Returns string

Methods

Protected addFulfillment

addFulfillment(fulfillment: Fulfillment): this

Inherited from FulfillableGoal.addFulfillment
- Defined in lib/api/goal/GoalWithFulfillment.ts:246
Parameters
- fulfillment: Fulfillment
Returns this

Protected addFulfillmentCallback

addFulfillmentCallback(cb: GoalFulfillmentCallback): this

Inherited from FulfillableGoal.addFulfillmentCallback
- Defined in lib/api/goal/GoalWithFulfillment.ts:238
Parameters
- cb: GoalFulfillmentCallback
Returns this

plan

plan(pli: StatefulPushListenerInvocation, goals: Goals): Promise<PlannedGoals | PlannedGoal>

Implementation of PlannableGoal.plan

Inherited from FulfillableGoal.plan
- Defined in lib/api/goal/GoalWithFulfillment.ts:291
Parameters
- pli: StatefulPushListenerInvocation
- goals: Goals
Returns Promise<PlannedGoals | PlannedGoal>

register

register(sdm: SoftwareDeliveryMachine): void

Implementation of Registerable.register

Overrides FulfillableGoal.register
- Defined in lib/pack/version/release.ts:96
Called by the SDM on initialization. This function calls super.register and adds a startup listener to the SDM.

The startup listener registers a default, no-op goal fulfillment.

Parameters
- sdm: SoftwareDeliveryMachine
Returns void

with

with(registration: ReleaseRegistration): this

- Defined in lib/pack/version/release.ts:112
Add fulfillment to this goal.

Parameters
- registration: ReleaseRegistration
Returns this

withExecutionListener

withExecutionListener(listener: GoalExecutionListener): this

Inherited from FulfillableGoal.withExecutionListener
- Defined in lib/api/goal/GoalWithFulfillment.ts:208
Parameters
- listener: GoalExecutionListener
Returns this

withProjectListener

withProjectListener(listener: GoalProjectListenerRegistration): this

Inherited from FulfillableGoal.withProjectListener
- Defined in lib/api/goal/GoalWithFulfillment.ts:203
Parameters
- listener: GoalProjectListenerRegistration
Returns this

withService

withService(registration: ServiceRegistration<any>): this

Inherited from FulfillableGoal.withService
- Defined in lib/api/goal/GoalWithFulfillment.ts:221
Parameters
- registration: ServiceRegistration<any>
Returns this

Generated using TypeDoc