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

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.0.91.tar.gz (124.1 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.0.91-py3-none-any.whl (123.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.91.tar.gz
Algorithm Hash digest
SHA256 10758c92a0901c32d22336e3d8ed729fe93de08fffe1231caad795b3a14671c9
MD5 1e9fdfd6c979b4a3808ae1d199257daa
BLAKE2b-256 978fa4f7f203f60a5bcd55dd947f930cee9717dc95d7f7558057d083ea4d2245

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.91-py3-none-any.whl
Algorithm Hash digest
SHA256 14323bf7157a7ec9079400d0c786e12770b86c16ad5c689cd1ffacacbe074bd3
MD5 53c44e765d827269f0a3c2ea09e9da02
BLAKE2b-256 2eab4a70fb70abc68cfb9ef6ab79cc8bbeee7328816150bdc3960851859c31f2

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