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.14.3.tar.gz (136.0 kB 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.14.3-py3-none-any.whl (134.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.14.3.tar.gz
Algorithm Hash digest
SHA256 9735141eaf2458ca663cd956f7d54f7156ca8b0f84ea5f866c2c9241947eb42b
MD5 09312d7f28347686684ea7431629f760
BLAKE2b-256 6606cd1daa758bfc424ec5ce006fc4456757c3c6eec4d0ec7f91c7162d45991e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.14.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8d3d723dc8c3a0625651575ccad7edb4dba1ea70c280b80db33ac301e012f76b
MD5 3e31ad6b727d08a0666bdeeb692a1d87
BLAKE2b-256 5fdf5431dbe52880a86bc465246c7599f3cc63123ce86a388a02c49900f8d53c

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