Class CheckoutStep

Checkout a repository.

Hierarchy

  • GitHubActionStep
    • CheckoutStep

Constructors

constructor

Properties

dependencyFileSets env id isSource jobSteps

Accessors

consumedStackOutputs dependencies primaryOutput

Methods

addDependencyFileSet addStepDependency configurePrimaryOutput discoverReferencedOutputs toString sequence

Constructors

constructor

Properties

Readonly dependencyFileSets

dependencyFileSets: FileSet[]

The list of FileSets consumed by this Step

Readonly env

env: Record<string, string>

Readonly id

id: string

Identifier for this step

Readonly isSource

isSource: boolean

Whether or not this is a Source step

What it means to be a Source step depends on the engine.

Readonly jobSteps

jobSteps: JobStep[]

Accessors

consumedStackOutputs

  • get consumedStackOutputs(): StackOutputReference[]

  • StackOutputReferences this step consumes.

    Returns StackOutputReference[]

dependencies

  • get dependencies(): Step[]

  • Return the steps this step depends on, based on the FileSets it requires

    Returns Step[]

primaryOutput

  • get primaryOutput(): undefined | FileSet

  • The primary FileSet produced by this Step

    Not all steps produce an output FileSet--if they do you can substitute the Step object for the FileSet object.

    Returns undefined | FileSet

Methods

Protected addDependencyFileSet

  • Add an additional FileSet to the set of file sets required by this step

    This will lead to a dependency on the producer of that file set.

    Parameters

    • fs: FileSet

    Returns void

addStepDependency

  • Add a dependency on another step.

    Parameters

    • step: Step

    Returns void

Protected configurePrimaryOutput

  • Configure the given FileSet as the primary output of this step

    Parameters

    • fs: FileSet

    Returns void

Protected discoverReferencedOutputs

  • Crawl the given structure for references to StepOutputs and add dependencies on all steps found

    Should be called in the constructor of subclasses based on what the user passes in as construction properties. The format of the structure passed in here does not have to correspond exactly to what gets rendered into the engine, it just needs to contain the same data.

    Parameters

    • structure: any

    Returns void

toString

  • Return a string representation of this Step

    Returns string

Static sequence

  • Define a sequence of steps to be executed in order.

    If you need more fine-grained step ordering, use the addStepDependency() API. For example, if you want secondStep to occur after firstStep, call secondStep.addStepDependency(firstStep).

    Parameters

    • steps: Step[]

    Returns Step[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc