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

CDK Nag

In order to keep CDK Nag happy, make sure you build the pipeline before synth as per https://github.com/aws/aws-cdk/issues/18440.

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.7.3.tar.gz (132.5 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.7.3-py3-none-any.whl (130.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.7.3.tar.gz
Algorithm Hash digest
SHA256 f7f66aabf67b80fd7b68a5a28e77ddf7287fc20e30a4cc13d5b555f1e5808836
MD5 5f2f8f5a0800678f3e274d5944c94f26
BLAKE2b-256 dcaedf05388f510336cd6fd87ae816112ed19385cb555265b006a22e3b3e9064

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d2e3eed265d60ae23c74c1295d1b209df83cb72641929cbe40ad084e7db720b9
MD5 b4bcdbbbe9bf2d5121592a89f1846a86
BLAKE2b-256 0175a7c122eba7487518d6a2e324e379f7ebaeeb14ba0d62f23216bdcca048dc

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