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.84.tar.gz (123.9 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.84-py3-none-any.whl (123.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.84.tar.gz
Algorithm Hash digest
SHA256 c617a163e57035293c307ca1e7b0ac1184586b4ba7694c059f2f92d71e5008f9
MD5 9d398580948eb15ac4ea3cdd9a308827
BLAKE2b-256 8213e20f07eb25322261787a20d64b96dacb9e749d49d72e138bd9442fb31f54

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.0.84-py3-none-any.whl
Algorithm Hash digest
SHA256 8f6fe9fd18ddd81dd526bc9b9afcdedb9c6549bea8c262fea4c07196d735530d
MD5 68b9de165f4affd0017b2fbb836a1537
BLAKE2b-256 1be42b3e50dc3f0f842b7cd16678af2e983df19e11f888f4ec1333b279df1d5b

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