Class GithubCodePipeline

props

ReadonlysynthProps

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?: string): GithubCodePipeline

  Setup synth step access to external configs repository.

  Parameters

  • OptionalsecretName: string

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

  Returns GithubCodePipeline

addNxEnv

• addNxEnv(accessTokenSecret?: string): GithubCodePipeline

  Set up the synth step for use with NX.

  Parameters

  • OptionalaccessTokenSecret: string

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

  Returns GithubCodePipeline

addSynthEnv

• addSynthEnv(env: Record<string, string>): GithubCodePipeline

  Add environment variables to the synth step.

  Parameters

  • env: Record<string, string>

    The environment variables to add.

  Returns GithubCodePipeline

build

• build(scope: Construct, id?: string): GithubWorkflowPipeline

  Build a GithubWorkflowPipeline instance.

  Parameters

  • scope: Construct

    The scope for the pipeline.
  • Optionalid: string

    The ID for the pipeline.

  Returns GithubWorkflowPipeline

buildCredentialsProvider

• buildCredentialsProvider(
      accountIdSecretName?: string,
      roleName?: string,
  ): AwsCredentialsProvider

  Build a credentials provider for the pipeline.

  Parameters

  • OptionalaccountIdSecretName: string

    The name of the secret containing the account ID. Defaults to AWS_PIPELINE_ACCOUNT_ID.
  • OptionalroleName: string

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

  Returns AwsCredentialsProvider

buildS3Ref

• buildS3Ref(key: string): S3ObjectRef

  Build an S3 reference for the given key.

  Parameters

  • key: string

    The key to build a reference for.

  Returns S3ObjectRef

buildSynth

• buildSynth(id?: string): ShellStep

  Build the synth step.

  Parameters

  • Optionalid: string

    The ID for the synth step.

  Returns ShellStep

clone

• clone(
      newProps?: Partial<PipelineWorkflowProps>,
      synthProps?: Partial<ShellStepProps>,
  ): GithubCodePipeline

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

  Parameters

  • OptionalnewProps: Partial<PipelineWorkflowProps>

    The new props to merge.
  • OptionalsynthProps: 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?: string): GithubCodePipeline

  Install AWS CLI.

  Parameters

  • OptionaltoolVersion: string

    The version of AWS CLI to install.

  Returns GithubCodePipeline

installHelm

• installHelm(toolVersion?: string): GithubCodePipeline

  Install Helm.

  Parameters

  • OptionaltoolVersion: string

    The version of Helm to install.

  Returns GithubCodePipeline

installNode

• installNode(nodeVersion?: string, cache?: string): GithubCodePipeline

  Setup NodeJS

  Parameters

  • OptionalnodeVersion: string

    The version of NodeJS to install.
  • Optionalcache: string

    The version of NodeJS to install.

  Returns GithubCodePipeline

installPnpm

• installPnpm(pnpmVersion?: string): GithubCodePipeline

  Setup PNPM.

  Parameters

  • OptionalpnpmVersion: string

    The version of PNPM to install.

  Returns GithubCodePipeline

installSops

• installSops(toolVersion?: string): GithubCodePipeline

  Install SOPs.

  Parameters

  • OptionaltoolVersion: string

    The version of SOPs to install.

  Returns GithubCodePipeline

patch

• patch(patcher: WorkflowPatcher): GithubCodePipeline

  Add patch callback.

  Parameters

  • patcher: WorkflowPatcher

    factory for creating patches.

  Returns GithubCodePipeline

publishPostStep

• publishPostStep(...step: JobStep[]): GithubCodePipeline

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

  Parameters

  • ...step: JobStep[]

    The step(s) to add.

  Returns GithubCodePipeline

publishPreStep

• publishPreStep(...step: JobStep[]): GithubCodePipeline

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

  Parameters

  • ...step: JobStep[]

    The step(s) to add.

  Returns GithubCodePipeline

synthCheckout

• synthCheckout(props: CheckoutProps): 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: WorkflowPatcher): GithubCodePipeline

  Add patcher for synth job.

  Parameters

  • patcher: WorkflowPatcher

    patcher factory to apply.

  Returns GithubCodePipeline

synthPostStep

• synthPostStep(...step: PipelineStep[]): GithubCodePipeline

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

  Parameters

  • ...step: PipelineStep[]

    The step(s) to add.

  Returns GithubCodePipeline

synthPreStep

• synthPreStep(...step: PipelineStep[]): GithubCodePipeline

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

  Parameters

  • ...step: PipelineStep[]

    The step(s) to add.

  Returns GithubCodePipeline

synthTarget

• synthTarget(target: SynthTarget): 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.

Staticcreate

• create(createProps: GithubCodePipelineCreateProps): GithubCodePipeline

  Create a new pipeline.

  Parameters

  • createProps: GithubCodePipelineCreateProps

    initial props.

  Returns GithubCodePipeline