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.0.92.tar.gz (124.2 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.0.92-py3-none-any.whl (123.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.92.tar.gz
Algorithm Hash digest
SHA256 999ce4e939d5302a6ff74bd961d65e371e0f6aed4f1bc35de47251d05731c1b3
MD5 cf3f41de7071a2b4fff488449d6c0a70
BLAKE2b-256 be966c224843c6be82cc438edaa0d775db9eb9e0f5558de76b02dd2c626c5cbc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.92-py3-none-any.whl
Algorithm Hash digest
SHA256 767b5102f2c93bb514ee47196aae622aebaf5d907f43a40231a5d126f4d0e1da
MD5 87cf8300113d8c1b64d4188ae997102e
BLAKE2b-256 11ea815d260ad0f633d1fd65ea756d6b66bea3f59b077047c0e645c7ed945204

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