Skip to main content

@aws-prototyping-sdk/pipeline

Project description

The pipeline module vends an extension to CDK's CodePipeline construct, named PDKPipeline. It additionally creates a CodeCommit repository and by default is configured to build the project assumming nx-monorepo is being used (although this can be changed). A Sonarqube Scanner can also be configured to trigger a scan whenever the synth build job completes successfully. This Scanner is non-blocking and as such is not instrumented as part of the pipeline.

The architecture for the PDKPipeline is as follows:

CodeCommit repository -> CodePipeline
                             |-> EventBridge Rule (On Build Succeded) -> CodeBuild (Sonar Scan)
                             |-> Secret (sonarqube token)

This module additionally vends multiple Projen Projects, one for each of the supported languages. These projects aim to bootstrap your project by providing sample code which uses the PDKPipeline construct.

For example, in .projenrc.ts:

new PDKPipelineTsProject({
    cdkVersion: "2.1.0",
    defaultReleaseBranch: "mainline",
    devDeps: ["aws-prototyping-sdk"],
    name: "my-pipeline",
});

This will generate a package in typescript containing CDK boilerplate for a pipeline stack (which instantiates PDKPipeline), sets up a Dev stage with an Application Stage containing an empty ApplicationStack (to be implemented). Once this package is synthesized, you can run npx projen and projen will synthesize your cloudformation.

Alternatively, you can initialize a project using the cli (in an empty directory) for each of the supported languages as follows:

# Typescript
npx projen new --from aws-prototyping-sdk pdk-pipeline-ts
# Python
npx projen new --from aws-prototyping-sdk pdk-pipeline-py
# Java
npx projen new --from aws-prototyping-sdk pdk-pipeline-java

CDK Nag

In order to keep CDK Nag happy, make sure you build the pipeline before synth as per https://github.com/aws/aws-cdk/issues/18440.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws_prototyping_sdk.pipeline-0.15.3.tar.gz (78.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aws_prototyping_sdk.pipeline-0.15.3-py3-none-any.whl (78.3 MB view details)

Uploaded Python 3

File details

Details for the file aws_prototyping_sdk.pipeline-0.15.3.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.15.3.tar.gz
Algorithm Hash digest
SHA256 4089b8bfd1433ebec004f924ba931e707641bd7c9228a68e261274f52b3856ee
MD5 62822377ac7886e26887bf0689fb762b
BLAKE2b-256 0a50d172fbe659cbf21a2c6124af0479799b0ee636c3e20a194d227ce90501bb

See more details on using hashes here.

File details

Details for the file aws_prototyping_sdk.pipeline-0.15.3-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.15.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0e38bada5b42c2cd732601e3c05025c7904ddc52c127778d993da1df2c2001f9
MD5 80c0051c3b74a46fd17ea2e2d9eb8da2
BLAKE2b-256 2a9025a38a12b95bbd7e1041f46356514936f43be27d0e8b856e12581aa8cd9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page