Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Artifact

This goal is fulfilled by an OnImageLinked event subscription. The Build goal will cause such an event to be emitted, but external CI systems can trigger the goal fulfillment as well. On fulfillment, the external URL for the artifact will be put on the goal instance and shown in the client.

You can register listeners on this event to trigger when a new artifact is available through this goal.

Hierarchy

Implements

  • Registerable

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

    • Default value goalDetailsOrUniqueName: FulfillableGoalDetails | string = DefaultGoalNameGenerator.generateName("artifact")
    • Rest ...dependsOn: Goal[]

    Returns Artifact

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

name

name: string

plannedDescription

plannedDescription: string

projectListeners

projectListeners: GoalProjectListenerRegistration[]

registrations

registrations: ArtifactRegistration[]

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

  • Parameters

    • fulfillment: Fulfillment

    Returns this

Protected addFulfillmentCallback

  • addFulfillmentCallback(cb: GoalFulfillmentCallback): this

  • Parameters

    • cb: GoalFulfillmentCallback

    Returns this

Private handle

  • handle(event: EventFired<Subscription>, context: HandlerContext, goal: Artifact): Promise<HandlerResult>

register

  • register(sdm: SoftwareDeliveryMachine): void

  • Parameters

    • sdm: SoftwareDeliveryMachine

    Returns void

with

  • Parameters

    Returns this

withExecutionListener

  • withExecutionListener(listener: GoalExecutionListener): this

  • Parameters

    • listener: GoalExecutionListener

    Returns this

withProjectListener

  • withProjectListener(listener: GoalProjectListenerRegistration): this

  • Parameters

    • listener: GoalProjectListenerRegistration

    Returns this

withService

  • withService(registration: ServiceRegistration<any>): this

  • Parameters

    • registration: ServiceRegistration<any>

    Returns this

Generated using TypeDoc