"api-helper/goal/executeGoal"

Index

Classes

Functions

executeGoal

executeGoal(rules: { goalExecutionListeners: GoalExecutionListener[]; projectLoader: ProjectLoader }, implementation: GoalImplementation, gi: GoalInvocation): Promise<ExecuteGoalResult>

- Defined in lib/api-helper/goal/executeGoal.ts:79
Central function to execute a goal with progress logging

Parameters
- rules: { goalExecutionListeners: GoalExecutionListener[]; projectLoader: ProjectLoader }
  - goalExecutionListeners: GoalExecutionListener[]
  - projectLoader: ProjectLoader
- implementation: GoalImplementation
- gi: GoalInvocation
Returns Promise<ExecuteGoalResult>

executeHook

executeHook(rules: { projectLoader: ProjectLoader }, goalInvocation: GoalInvocation, sdmGoal: SdmGoalEvent, stage: "post" | "pre"): Promise<HandlerResult>

- Defined in lib/api-helper/goal/executeGoal.ts:222
Parameters
- rules: { projectLoader: ProjectLoader }
  - projectLoader: ProjectLoader
- goalInvocation: GoalInvocation
- sdmGoal: SdmGoalEvent
- stage: "post" | "pre"
Returns Promise<HandlerResult>

goalToHookFile

goalToHookFile(sdmGoal: SdmGoalEvent, prefix: string): string

- Defined in lib/api-helper/goal/executeGoal.ts:280
Parameters
- sdmGoal: SdmGoalEvent
- prefix: string
Returns string

handleGitRefErrors

handleGitRefErrors(result: ExecuteGoalResult, error: Error & any): ExecuteGoalResult

- Defined in lib/api-helper/goal/executeGoal.ts:316
Parameters
- result: ExecuteGoalResult
- error: Error & any
Returns ExecuteGoalResult

markGoalInProcess

markGoalInProcess(parameters: { ctx: HandlerContext; goal: Goal; goalEvent: SdmGoalEvent; progressLogUrl: string }): Promise<SdmGoalEvent>

- Defined in lib/api-helper/goal/executeGoal.ts:332
Parameters
- parameters: { ctx: HandlerContext; goal: Goal; goalEvent: SdmGoalEvent; progressLogUrl: string }
  - ctx: HandlerContext
  - goal: Goal
  - goalEvent: SdmGoalEvent
  - progressLogUrl: string
Returns Promise<SdmGoalEvent>

markStatus

markStatus(parameters: { context: HandlerContext; error?: Error; goal: Goal; goalEvent: SdmGoalEvent; progressLogUrl: string; result: ExecuteGoalResult }): Promise<void>

- Defined in lib/api-helper/goal/executeGoal.ts:286
Parameters
- parameters: { context: HandlerContext; error?: Error; goal: Goal; goalEvent: SdmGoalEvent; progressLogUrl: string; result: ExecuteGoalResult }
  - context: HandlerContext
  - Optional error?: Error
  - goal: Goal
  - goalEvent: SdmGoalEvent
  - progressLogUrl: string
  - result: ExecuteGoalResult
Returns Promise<void>

prepareGoalExecutor

prepareGoalExecutor(gi: GoalImplementation, sdmGoal: SdmGoalEvent, configuration: SoftwareDeliveryMachineConfiguration): ExecuteGoal

- Defined in lib/api-helper/goal/executeGoal.ts:392
Parameters
- gi: GoalImplementation
- sdmGoal: SdmGoalEvent
- configuration: SoftwareDeliveryMachineConfiguration
Returns ExecuteGoal

prepareGoalInvocation

prepareGoalInvocation(gi: GoalInvocation, listeners: GoalProjectListenerRegistration | GoalProjectListenerRegistration[]): GoalInvocation

- Defined in lib/api-helper/goal/executeGoal.ts:405
Parameters
- gi: GoalInvocation
- listeners: GoalProjectListenerRegistration | GoalProjectListenerRegistration[]
Returns GoalInvocation

reportGoalError

reportGoalError(parameters: { addressChannels: AddressChannels; goal: Goal; id: RemoteRepoRef; implementationName: string; logInterpreter: InterpretLog; progressLog: ProgressLog }, err: GoalExecutionError): Promise<void>

- Defined in lib/api-helper/goal/executeGoal.ts:354
Report an error executing a goal and present a retry button

Parameters
- parameters: { addressChannels: AddressChannels; goal: Goal; id: RemoteRepoRef; implementationName: string; logInterpreter: InterpretLog; progressLog: ProgressLog }
  - addressChannels: AddressChannels
  - goal: Goal
  - id: RemoteRepoRef
  - implementationName: string
  - logInterpreter: InterpretLog
  - progressLog: ProgressLog
- err: GoalExecutionError
Returns Promise<void>

Index

Classes

Functions

Functions

executeGoal

Parameters

rules: { goalExecutionListeners: GoalExecutionListener[]; projectLoader: ProjectLoader }

goalExecutionListeners: GoalExecutionListener[]

projectLoader: ProjectLoader

implementation: GoalImplementation

gi: GoalInvocation

Returns Promise<ExecuteGoalResult>

executeHook

Parameters

rules: { projectLoader: ProjectLoader }

projectLoader: ProjectLoader

goalInvocation: GoalInvocation

sdmGoal: SdmGoalEvent

stage: "post" | "pre"

Returns Promise<HandlerResult>

goalToHookFile

Parameters

sdmGoal: SdmGoalEvent

prefix: string

Returns string

handleGitRefErrors

Parameters

result: ExecuteGoalResult

error: Error & any

Returns ExecuteGoalResult

markGoalInProcess

Parameters

parameters: { ctx: HandlerContext; goal: Goal; goalEvent: SdmGoalEvent; progressLogUrl: string }

ctx: HandlerContext

goal: Goal

goalEvent: SdmGoalEvent

progressLogUrl: string

Returns Promise<SdmGoalEvent>

markStatus

Parameters

parameters: { context: HandlerContext; error?: Error; goal: Goal; goalEvent: SdmGoalEvent; progressLogUrl: string; result: ExecuteGoalResult }

context: HandlerContext

Optional error?: Error

goal: Goal

goalEvent: SdmGoalEvent

progressLogUrl: string

result: ExecuteGoalResult

Returns Promise<void>

prepareGoalExecutor

Parameters

gi: GoalImplementation

sdmGoal: SdmGoalEvent

configuration: SoftwareDeliveryMachineConfiguration

Returns ExecuteGoal

prepareGoalInvocation

Parameters

gi: GoalInvocation

listeners: GoalProjectListenerRegistration | GoalProjectListenerRegistration[]

Returns GoalInvocation

reportGoalError

Parameters

parameters: { addressChannels: AddressChannels; goal: Goal; id: RemoteRepoRef; implementationName: string; logInterpreter: InterpretLog; progressLog: ProgressLog }

addressChannels: AddressChannels

goal: Goal

id: RemoteRepoRef

implementationName: string

logInterpreter: InterpretLog

progressLog: ProgressLog

err: GoalExecutionError

Returns Promise<void>