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.73.tar.gz (121.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.0.73-py3-none-any.whl (121.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.73.tar.gz
Algorithm Hash digest
SHA256 1ea23c8326a4d46362118795dbb01a112a5348972a6a1576e8ae15aff267d1a6
MD5 faa183d628c0c5df89d7b67feedd5b74
BLAKE2b-256 a9ae26a98ae3e4f992e37557678756c91135e89866e4b5723f4f378e1a3c8b1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.73-py3-none-any.whl
Algorithm Hash digest
SHA256 e7b894d40bd85e2f323b15df63355c814464e0b170be717c4e05ae50d35328d6
MD5 1df7927c978f57400a47cbd5119497bc
BLAKE2b-256 db9c0b7fad44f7ddc04f6bdc7165b0dee8feedbd2498287db686e5bf31e7ea7c

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