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.13.3.tar.gz (136.0 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.13.3-py3-none-any.whl (134.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.13.3.tar.gz
Algorithm Hash digest
SHA256 a5d52a2a012f343f1da8786da9c45d93c89e126b10e909b295652e6ae92639ff
MD5 e3c18a4e900c8d0de94bc6fdad61201d
BLAKE2b-256 f9fcbed48119b24b96479a87c132fc4a7ec4c9de2e7d04b7aabf87f5e7c3a000

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.13.3-py3-none-any.whl
Algorithm Hash digest
SHA256 62f70bab48030bc68b551707f759550142ef1f9c34c9ca8aff2a82db24c98255
MD5 f300aa0bbd7935ef6d944454ab4315e8
BLAKE2b-256 66084ba85c1db43c4ea536f35bed69fc140443cc1dd0e8820d49a8a1165ad08f

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