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.85.tar.gz (124.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.0.85-py3-none-any.whl (123.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.85.tar.gz
Algorithm Hash digest
SHA256 62b59b4ad62cac6cbb313f7ec48ed9d095e36c8a45757b36242f6d675aa65188
MD5 f79239240cecb7cdae39e1cbb5a433b8
BLAKE2b-256 ffadd7223273d38c6ed6b84862838297bce0213c7d71761f1db2487539c29df7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.85-py3-none-any.whl
Algorithm Hash digest
SHA256 6f0d4ea74eff7306c11550a30fadc37f7cb32152e194a9d6fdc720d41a56d93a
MD5 9cb7fad32ca0a80373831cf007397690
BLAKE2b-256 4416c157b3c7073e17f75723993766678b5f58431e42bdbe937d4b75c62bb30c

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