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.0

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.3.0.tar.gz
Algorithm Hash digest
SHA256 9fd7da26a235c99d6dc16d84d70a531436827045c2a5dbc869274378a9b2abb8
MD5 16baed8016af6cae2f67637e19919a86
BLAKE2b-256 eba77b7e8bf9d80b495c27e7ffb1e657d81f8e6fcd1ff01a10570e1dff4135e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5997215158fae29739090241cdf3be8d2fced32786b325f7a5aa76c5a0820aba
MD5 0cbc78f4c94d8adad94e44b5650cf41a
BLAKE2b-256 20411f80f237cd03c090aa11d837406613dd3bbcf12f17fa59465f679d446190

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