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.2.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.2.2-py3-none-any.whl (123.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.2.tar.gz
Algorithm Hash digest
SHA256 560f4de7ee9ca21dd7c47969d4ec9460e2201fef551ebaaf6baca16eb37d1533
MD5 10b181a5c1e62c6a9a2fe21b9da64daf
BLAKE2b-256 5033198a80dedd50f5f24b7d81cf7211b35f7514e9ef5c72d89425e3dd1f3dc5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.pipeline-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fd51efd60ec32efce087158df0a598090e96f6816d0ed4fa48d351c3a32cb871
MD5 81bc797bfe65362f21f70b27cc68e2b6
BLAKE2b-256 d5e91ed9e0dd23374b3d7ea48a8d2d33128634f8e140f29bea8eee983532f7c0

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