Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DockerPublishJob

A job to build and publish a Docker image.

Hierarchy

  • CheckoutJob
    • DockerPublishJob

Implements

  • IConstruct

Index

Constructors

constructor

  • Parameters

    • scope: Workflow

      cdkactions Workflow instance.

    • id: string

      Id of the job.

    • config: DockerPublishJobProps

      Configuration for the docker publish job.

    • Optional overrides: Partial<JobProps>

      Optional overrides for the job.

    Returns DockerPublishJob

Properties

Readonly dockerImageName

dockerImageName: string

Full name of the docker image built.

Readonly id

id: string

A unique identifier.

stability

stable

Methods

Protected onPrepare

  • onPrepare(): void
  • Perform final modifications before synthesis.

    This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.

    This is an advanced framework feature. Only use this if you understand the implications.

    stability

    stable

    Returns void

Protected onSynthesize

  • onSynthesize(session: ISynthesisSession): void
  • Allows this construct to emit artifacts into the cloud assembly during synthesis.

    This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

    stability

    stable

    Parameters

    • session: ISynthesisSession

      The synthesis session.

    Returns void

Protected onValidate

  • onValidate(): string[]
  • (deprecated) Validate the current construct.

    This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

    deprecated

    use Node.addValidation() to subscribe validation functions on this construct instead of overriding this method.

    Returns string[]

    An array of validation error messages, or an empty array if there the construct is valid.

toGHAction

  • toGHAction(): any
  • Converts the job's configuration into a format that is GitHub Actions compatible.

    stability

    stable

    Returns any

toString

  • toString(): string
  • Returns a string representation of this construct.

    stability

    stable

    Returns string

Generated using TypeDoc