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.8.tar.gz (123.7 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.8-py3-none-any.whl (123.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.8.tar.gz
Algorithm Hash digest
SHA256 065debacb387da44f1103e86045651b41d7d1d785e16eb1a1457432dc83125d4
MD5 ea990f3d6e1fe142450b591f91695cdd
BLAKE2b-256 6530b2e41476b4118f20bff1a77fa0563808bb427b9ae845890f776a665c83dd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 950badefb7c3e8c0daeb1d8a35b9c0daeebc322fe502de4c876dda4a85e7c1c6
MD5 99cae1fe6c2a1c7e2e9121b1e5ab3803
BLAKE2b-256 48c8a58ff0dadeac0b05b5027154009a8c1faa1cc48cb3db7040bd1ab60b8613

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