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

This version

0.3.3

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.3.3.tar.gz (112.8 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.3.3-py3-none-any.whl (112.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.3.3.tar.gz
Algorithm Hash digest
SHA256 87f2fc5f6a89e6a615401b212f60cd9f66e68926a66ed1272a1c76267e812207
MD5 5d6c28e5f26c0b56983813f42a930288
BLAKE2b-256 5fc22bcedcd5a7ee3021ca083530652f8a04ab2340ce18ebffd7408272681719

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5a018aed7377dd41897a8411e5ebf4357962ccd16c65f54d9b4d09c91071468a
MD5 611c4dee879413b2cadd375038464f2a
BLAKE2b-256 9aad4105a689e73df595cda921ea30bf34cd53bf7cb821f66fa424c66b2723e7

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