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.7.tar.gz (123.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.2.7-py3-none-any.whl (123.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.7.tar.gz
Algorithm Hash digest
SHA256 b63f5d485fbcee03be92ca7ebba5ca0585f08d5d91de91b42cdbf0be1e341ef9
MD5 e42ecc927a20477ee73386ec2e2e9d48
BLAKE2b-256 9518ff0a065e2701fa646347aad6d31cafb446d67b8c3bbd02cd62fab6233fc4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 67d004d6b9a1cca18b1f824b289df5cfb25158395480e2599c82133c608cfbdb
MD5 53a7b0e3a0a6589cc8eded9fb99f66d0
BLAKE2b-256 405fe41293c731089fca26988364e30ebb7268c86ba9cc7d47666644ce9d4948

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