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

This version

0.9.3

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.9.3.tar.gz (132.6 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.9.3-py3-none-any.whl (130.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.9.3.tar.gz
Algorithm Hash digest
SHA256 ef7849fe4aa7917136e6fa7af6db20d3d7123992c33a8ce5b87b5ab8fd1d0ed5
MD5 f492300db51c75c58517c2203673f617
BLAKE2b-256 420874d21c65ab1d20b6b0ffa70724b1674c9dfb7fb5928c75be8facb32049a8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5e89218a42930a7368c0a80f666ec30142f02ef4de7aead14b0865e78649d4c5
MD5 ad6dce51d5af0209c8401634425c49dd
BLAKE2b-256 47d21c2813f7b6b002fc2769ec18f2ce977013479a133c3a54e645d15d7cf289

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