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

This version

0.3.1

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.3.1.tar.gz (112.8 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.3.1-py3-none-any.whl (112.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.3.1.tar.gz
Algorithm Hash digest
SHA256 64ddd336aefaed95913a3f213d62d026ff1cdd637ca8aa4c584c368991f2003e
MD5 a60a2b87e9cba3d8d2704a3ecdcb1de8
BLAKE2b-256 96acd847eb67aef497a1ad45a3853b13418d7230cacf2359aef3ff893aef16e8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 59ed18012d14c691d83cd6c24ebbbe27d736752072de3875f7efbd11c8a49552
MD5 8dfee9617f1e38707fe14e423eb02a3f
BLAKE2b-256 a565d9f1fde96ea8b4b2727df4067f1822f1b10b3b93dfa588d12e1bbb1c7ea3

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