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.15.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.15-py3-none-any.whl (123.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.15.tar.gz
Algorithm Hash digest
SHA256 7e560c4eda6b354c82c3f9c490e1524f6971f7420fb9905d6cd35c94a8c6ed51
MD5 d915362fb7d0e251e2894961d2fc250b
BLAKE2b-256 2cffafebafd226674d3acd7bff904d0f0571c889c675d799f6ef72f5efee4038

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 22116ddbde78eb7300ed0e899118321bf31edd204c33d6a7a6ffa9410ec4dd4b
MD5 1684835c9805cdd4a72b60e1460f678e
BLAKE2b-256 f83e04005ca4e4c06fe056f05b472cabc815e596ea63ba41ecf00245a3828b14

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