Class GithubCodePipeline

props

Readonly synthProps

assetsKeyPrefix

• get assetsKeyPrefix(): string

• Prefix path for assets s3 target.

  Returns string

workflowPath

• get workflowPath(): string

• File path for workflow.

  Returns string

workflowSlug

• get workflowSlug(): string

• Slug for workflow created from PipelineBuildProps.workflowName.

  Returns string

addConfigsEnv

• addConfigsEnv(secretName?): GithubCodePipeline

• Setup synth step access to external configs repository.

  Parameters

  • Optional secretName: string

    Name of secret containing read-only PAT for configs repository. Defaults to GH_CONFIGS_RO_PAT.

  Returns GithubCodePipeline

addNxEnv

• addNxEnv(accessTokenSecret?): GithubCodePipeline

• Set up the synth step for use with NX.

  Parameters

  • Optional accessTokenSecret: string

    The name of the secret containing the access token. Defaults to NX_CLOUD_ACCESS_TOKEN.

  Returns GithubCodePipeline

addSynthEnv

• addSynthEnv(env): GithubCodePipeline

• Add environment variables to the synth step.

  Parameters

  • env: Record<string, string>

    The environment variables to add.

  Returns GithubCodePipeline

build

• build(scope, id?): GithubWorkflowPipeline

• Build a GithubWorkflowPipeline instance.

  Parameters

  • scope: Construct

    The scope for the pipeline.

  • Optional id: string

    The ID for the pipeline.

  Returns GithubWorkflowPipeline

buildCredentialsProvider

• buildCredentialsProvider(accountIdSecretName?, roleName?): AwsCredentialsProvider

• Build a credentials provider for the pipeline.

  Parameters

  • Optional accountIdSecretName: string

    The name of the secret containing the account ID. Defaults to AWS_PIPELINE_ACCOUNT_ID.

  • Optional roleName: string

    The name of the role to assume. Defaults to GitHubActionRole.

  Returns AwsCredentialsProvider

buildS3Ref

• buildS3Ref(key): S3ObjectRef

• Build an S3 reference for the given key.

  Parameters

  • key: string

    The key to build a reference for.

  Returns S3ObjectRef

buildSynth

• buildSynth(id?): ShellStep

• Build the synth step.

  Parameters

  • Optional id: string

    The ID for the synth step.

  Returns ShellStep

clone

• clone(newProps?, synthProps?): GithubCodePipeline

• Create a new pipeline with the given props merged with existing props.

  Parameters

  • Optional newProps: Partial<PipelineWorkflowProps>

    The new props to merge.

  • Optional synthProps: Partial<ShellStepProps>

    The new synth props to merge.

  Returns GithubCodePipeline

  Remarks

  This does not mutate the existing pipeline and returns a new instance.

defaultTools

• defaultTools(): GithubCodePipeline

• Install default tools.

  Returns GithubCodePipeline

installAwsCli

• installAwsCli(toolVersion?): GithubCodePipeline

• Install AWS CLI.

  Parameters

  • Optional toolVersion: string

    The version of AWS CLI to install.

  Returns GithubCodePipeline

installHelm

• installHelm(toolVersion?): GithubCodePipeline

• Install Helm.

  Parameters

  • Optional toolVersion: string

    The version of Helm to install.

  Returns GithubCodePipeline

installNode

• installNode(nodeVersion?, cache?): GithubCodePipeline

• Setup NodeJS

  Parameters

  • Optional nodeVersion: string

    The version of NodeJS to install.

  • Optional cache: string

    The version of NodeJS to install.

  Returns GithubCodePipeline

installPnpm

• installPnpm(pnpmVersion?): GithubCodePipeline

• Setup PNPM.

  Parameters

  • Optional pnpmVersion: string

    The version of PNPM to install.

  Returns GithubCodePipeline

installSops

• installSops(toolVersion?): GithubCodePipeline

• Install SOPs.

  Parameters

  • Optional toolVersion: string

    The version of SOPs to install.

  Returns GithubCodePipeline

patch

• patch(patcher): GithubCodePipeline

• Add patch callback.

  Parameters

  • patcher: WorkflowPatcher

    factory for creating patches.

  Returns GithubCodePipeline

publishPostStep

• publishPostStep(...step): GithubCodePipeline

• Add post-publish step(s) to the publish step.

  Parameters

  • Rest ...step: JobStep[]

    The step(s) to add.

  Returns GithubCodePipeline

publishPreStep

• publishPreStep(...step): GithubCodePipeline

• Add pre-publish step(s) to the publish step.

  Parameters

  • Rest ...step: JobStep[]

    The step(s) to add.

  Returns GithubCodePipeline

synthCheckout

• synthCheckout(props): GithubCodePipeline

• Add a checkout step before synth build.

  Parameters

  • props: CheckoutProps

    The props for the checkout step.

  Returns GithubCodePipeline

  Remarks

  This is a convenience method for adding a CheckoutStep via synthPreStep. A checkout step already exists for the current repository, so this is only necessary if you need to check out a different repository.

synthJobPatch

• synthJobPatch(patcher): GithubCodePipeline

• Add patcher for synth job.

  Parameters

  • patcher: WorkflowPatcher

    patcher factory to apply.

  Returns GithubCodePipeline

synthPostStep

• synthPostStep(...step): GithubCodePipeline

• Add post-build step(s) to the synth step.

  Parameters

  • Rest ...step: PipelineStep[]

    The step(s) to add.

  Returns GithubCodePipeline

synthPreStep

• synthPreStep(...step): GithubCodePipeline

• Add pre-build step(s) to the synth step.

  Parameters

  • Rest ...step: PipelineStep[]

    The step(s) to add.

  Returns GithubCodePipeline

synthTarget

• synthTarget(target): GithubCodePipeline

• Add a synth target to the pipeline.

  Parameters

  • target: SynthTarget

    The target to add.

  Returns GithubCodePipeline

  Remarks

  This will add any additional steps for pulling/pushing context and assets to/from S3.

Static create

• create(createProps): GithubCodePipeline

• Create a new pipeline.

  Parameters

  • createProps: GithubCodePipelineCreateProps

    initial props.

  Returns GithubCodePipeline