Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PyPIPublishStack

A stack to test a PyPI package on all branches as well as publish the package when a commit has a semver tag.

Hierarchy

  • Stack
    • PyPIPublishStack

Implements

  • IConstruct

Index

Constructors

constructor

  • Parameters

    • scope: Construct

      cdkactions App instance.

    • Optional config: PyPIPublishStackProps

      Optional configuration for the stack.

    • Optional overrides: Partial<WorkflowProps>

      Optional overrides for the workflow.

    Returns PyPIPublishStack

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
  • A custom onSynthesize function to generate GH Action manifests.

    stability

    stable

    Parameters

    • session: ISynthesisSession

      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.

toString

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

    stability

    stable

    Returns string

Generated using TypeDoc