@cosmos-building-blocks/pipeline

@cosmos-building-blocks/pipeline › Globals

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

BuildEnvironmentVariables

Ƭ BuildEnvironmentVariables: Record‹string, BuildEnvironmentVariable | string | undefined›

Defined in packages/@cosmos-building-blocks/pipeline/src/utils.ts:3

BuildSpecObject

Ƭ BuildSpecObject: object

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:34

Type declaration:

  • artifacts? : Artifact & object

  • cache? : undefined | object

  • env(): object

    • exported-variables? : string[]

    • git-credential-helper? : undefined | false | true

    • parameter-store? : Record‹string, string›

    • secrets-manager? : Record‹string, string›

    • shell? : undefined | string

    • variables? : Record‹string, string›

  • phases: Partial‹Record‹Phase, Commands›› & object

  • proxy? : undefined | object

  • reports? : Report[]

  • run-as? : undefined | string

  • version: "0.2"

EnvironmentVariables

Ƭ EnvironmentVariables: "variables" | "parameter-store" | "secrets-manager"

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:6

Event

Ƭ Event: CloudFormationCustomResourceCreateEvent | CloudFormationCustomResourceUpdateEvent | CloudFormationCustomResourceDeleteEvent

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook-handler/index.ts:9

NullableString

Ƭ NullableString: string | null | undefined

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:12

Phase

Ƭ Phase: "install" | "pre_build" | "build" | "post_build"

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:8

Response

Ƭ Response: object | undefined

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook-handler/index.ts:14

Runtime

Ƭ Runtime: "android" | "dotnet" | "golang" | "nodejs" | "java" | "php" | "python" | "ruby"

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:9

Version

Ƭ Version: "latest" | string

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:10

Variables

Const DOCKER_BUILD

• DOCKER_BUILD: "make build" = "make build"

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:14

Const DOCKER_EXPORT_APP_BUILD_VERSION

• DOCKER_EXPORT_APP_BUILD_VERSION: "export APP_BUILD_VERSION=$(make version)" = "export APP_BUILD_VERSION=$(make version)"

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:16

Const DOCKER_PUSH

• DOCKER_PUSH: "make push" = "make push"

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:15

Const ECR_LOGIN

• ECR_LOGIN: string = aws ecr get-login-password --region ${Aws.REGION} | docker login --username AWS --password-stdin https://${Aws.ACCOUNT_ID}.dkr.ecr.${Aws.REGION}.amazonaws.com

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:4

Const NPM_BUILD

• NPM_BUILD: "npm run build" = "npm run build"

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:10

Const NPM_EXPORT_APP_BUILD_VERSION

• NPM_EXPORT_APP_BUILD_VERSION: "export APP_BUILD_VERSION=v$(node -p "require('./package.json').version")-${CODEBUILD_BUILD_NUMBER}" = "export APP_BUILD_VERSION=v$(node -p "require('./package.json').version")-${CODEBUILD_BUILD_NUMBER}"

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:11

Const NPM_INSTALL

• NPM_INSTALL: "npm ci" = "npm ci"

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:9

Const NPM_LOGIN

• NPM_LOGIN: "echo "//registry.npmjs.org/:_authToken=${NPM_KEY}" >> ~/.npmrc" = "echo "//registry.npmjs.org/:_authToken=${NPM_KEY}" >> ~/.npmrc"

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:8

Const codebuild

• codebuild: CodeBuild‹› = new CodeBuild()

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook-handler/index.ts:23

Const gitHubEnterprise

• gitHubEnterprise: gitHubEnterprise = Source.gitHubEnterprise

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook.ts:64

Functions

Const createWebSocket

▸ createWebSocket(props: GithubEnterpriseWebhookProps): Promise‹Response›

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook-handler/index.ts:38

Parameters:

NameType
propsGithubEnterpriseWebhookProps

Returns: Promise‹Response›

Const deleteWebhook

▸ deleteWebhook(props: GithubEnterpriseWebhookProps): Promise‹Response›

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook-handler/index.ts:65

Parameters:

NameType
propsGithubEnterpriseWebhookProps

Returns: Promise‹Response›

Const filterNullableStrings

▸ filterNullableStrings(commands: NullableString[]): string[]

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:154

Parameters:

NameType
commandsNullableString[]

Returns: string[]

Const findAllStacksFromCdkApp

▸ findAllStacksFromCdkApp(scope: IConstruct): Stack[]

Defined in packages/@cosmos-building-blocks/pipeline/src/pipeline/cdk-pipeline.ts:377

Parameters:

NameType
scopeIConstruct

Returns: Stack[]

Const findOutputFromCdkCheckout

▸ findOutputFromCdkCheckout(stages: IStage[]): Artifact | undefined

Defined in packages/@cosmos-building-blocks/pipeline/src/pipeline/cdk-pipeline.ts:338

Parameters:

NameType
stagesIStage[]

Returns: Artifact | undefined

Const findStackDependencies

▸ findStackDependencies(stack: Stack): Stack[]

Defined in packages/@cosmos-building-blocks/pipeline/src/pipeline/cdk-pipeline.ts:385

Parameters:

NameType
stackStack

Returns: Stack[]

Const findStacksFromCdkDeployActions

▸ findStacksFromCdkDeployActions(pipeline: Pipeline): string[]

Defined in packages/@cosmos-building-blocks/pipeline/src/pipeline/cdk-pipeline.ts:350

Parameters:

NameType
pipelinePipeline

Returns: string[]

Const getEcrLogin

▸ getEcrLogin(registry: IRepository): string

Defined in packages/@cosmos-building-blocks/pipeline/src/commands.ts:5

Parameters:

NameType
registryIRepository

Returns: string

handler

▸ handler(event: Event): Promise‹Response›

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook-handler/index.ts:25

Parameters:

NameType
eventEvent

Returns: Promise‹Response›

Const parseEnvs

▸ parseEnvs(envs: BuildEnvironmentVariables | undefined): Record‹string, BuildEnvironmentVariable› | undefined

Defined in packages/@cosmos-building-blocks/pipeline/src/utils.ts:5

Parameters:

NameType
envsBuildEnvironmentVariables | undefined

Returns: Record‹string, BuildEnvironmentVariable› | undefined

Const stackNames

▸ stackNames(stacks: Array‹Stack | string›): string[]

Defined in packages/@cosmos-building-blocks/pipeline/src/pipeline/cdk-pipeline.ts:401

Parameters:

NameType
stacksArray‹Stack | string›

Returns: string[]

Const updateWebSocket

▸ updateWebSocket(props: GithubEnterpriseWebhookProps): Promise‹Response›

Defined in packages/@cosmos-building-blocks/pipeline/src/source/github-enterprise-webhook-handler/index.ts:52

Parameters:

NameType
propsGithubEnterpriseWebhookProps

Returns: Promise‹Response›