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.2.5.tar.gz (123.9 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.2.5-py3-none-any.whl (123.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.5.tar.gz
Algorithm Hash digest
SHA256 fc146997c33005bee794269f4068311037a6d2ed363f89a899e908971fbfae67
MD5 1d89ccbe217a0f7ec8beedcf350f050c
BLAKE2b-256 3928d290d33a1cc754a987caeeb937a527462a38db67c9197aa7dcf56d3cbf46

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ed32b050f0c26ea0e24f1bf05006cd60d3053d1f3d11ecf18d4a2df4f206fa16
MD5 d9a854eb994021a68ca643a9a9888898
BLAKE2b-256 813d60e3f23fb055017e19dfd62d8d20fd084909644089027762c8c99a11b63c

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