projen-pipelines 0.0.1 → 0.0.3

package/README.md

@@ -1 +1,154 @@
-# replace this
+# Projen Pipelines
+
+[![npm version](https://badge.fury.io/js/projen-pipelines.svg)](https://www.npmjs.com/package/projen-pipelines)
+
+
+Projen Pipelines is a projen library that provides high-level abstractions for defining continuous delivery (CD) pipelines for AWS CDK applications.
+It is specifically designed to work with the projen project configuration engine.
+
+This library provides high-level abstractions for defining multi-environment and multi-account AWS CDK applications with ease.
+With this library, you can handle complex deployment scenarios with less code and manage your AWS infrastructure in a more efficient and straightforward way.
+
+## Getting Started
+
+### Installation
+
+To install the package, add the package `projen-pipelines` to your projects devDeps in your projen configuration file.
+
+
+After installing the package, you can import and use the constructs to define your CDK Pipelines.
+
+### Usage
+
+You can start using the constructs provided by Projen Pipelines in your AWS CDK applications. Here's a brief example:
+
+```typescript
+import { awscdk } from 'projen';
+import { CDKPipeline, CDKPipelineOptions } from 'projen-pipelines';
+
+// Define your AWS CDK TypeScript App
+const app = new awscdk.AwsCdkTypeScriptApp({
+  cdkVersion: '2.80.0',
+  name: 'my-awesome-app',
+  defaultReleaseBranch: 'main',
+  devDeps: [
+    'projen-pipelines',
+  ],
+});
+
+// Create the pipeline
+new CDKPipeline(app, {
+  stackPrefix: 'MyApp',
+  pkgNamespace: '@company-assemblies',
+  environments: {
+    dev: { account: '111111111111', region: 'eu-central-1' },
+    prod: { account: '222222222222', region: 'eu-central-1' },
+  },
+});
+```
+
+After running projen (`npx projen`) a new file called `src/app.ts` will be created and contain a specialized CDK App class for your project.
+
+You can then use this in your `main.ts` to configure your deployment.
+
+```typescript
+import { PipelineApp } from './app';
+import { BackendStack } from './stack';
+
+const app = new PipelineApp({
+  provideDevStack: (scope, id, props) => {
+    return new BackendStack(scope, id, {
+      ...props,
+      apiHostname: 'api-dev',
+      myConfigSetting: 'value-for-dev',
+    });
+  },
+  provideProdStack: (scope, id, props) => {
+    return new BackendStack(scope, id, {
+      ...props,
+      apiHostname: 'api',
+      myConfigSetting: 'value-for-prod',
+    });
+  },
+  providePersonalStack: (scope, id, props) => {
+    return new BackendStack(scope, id, {
+      ...props,
+      apiHostname: `api-${props.stageName}`,
+      myConfigSetting: 'value-for-personal-stage',
+    });
+  },
+});
+
+app.synth();
+```
+
+### Deployment
+
+The `CDKPipeline` class creates and adds several tasks to the projen project that then can be used in your pipeline to deploy your application to AWS.
+
+Here's a brief description of each one:
+
+1. **deploy:personal** - This task deploys the application's personal stage, which is a distinct, isolated deployment of the application. The personal stage is intended for personal use, such as testing and development.
+
+2. **watch:personal** - This task deploys the personal stage of the application in watch mode. In this mode, the AWS CDK monitors your application source files for changes, automatically re-synthesizing and deploying when it detects any changes.
+
+3. **diff:personal** - This task compares the deployed personal stage with the current state of the application code. It's used to understand what changes would be made if the application were deployed.
+
+4. **destroy:personal** - This task destroys the resources created for the personal stage of the application.
+
+5. **deploy:feature** - This task deploys the application's feature stage. The feature stage is used for new features testing before these are merged into the main branch.
+
+6. **diff:feature** - This task is similar to `diff:personal`, but for the feature stage.
+
+7. **destroy:feature** - This task destroys the resources created for the feature stage of the application.
+
+8. **deploy:<stageName>** - This task deploys a specific stage of the application (like 'dev' or 'prod').
+
+9. **diff:<stageName>** - This task compares the specified application stage with the current state of the application code.
+
+10. **publish:assets** - This task publishes the CDK assets to all accounts. This is useful when the CDK application uses assets like Docker images or files from the S3 bucket.
+
+11. **bump** - This task bumps the version based on the latest git tag and pushes the updated tag to the git repository.
+
+12. **release:push-assembly** - This task creates a manifest, bumps the version without creating a git tag, and publishes the cloud assembly to your registry.
+
+Remember that these tasks are created and managed automatically by the `CDKPipeline` class. You can run these tasks using the `npx projen TASK_NAME` command.
+
+
+## Contributing
+
+We welcome all contributions to Projen Pipelines! Here's how you can get started:
+
+1. **Fork the Repository**: Click the 'Fork' button at the top right of this page to duplicate this repository in your GitHub account.
+
+2. **Clone your Fork**: Clone the forked repository to your local machine.
+
+```bash
+git clone https://github.com/<your_username>/projen-pipelines.git
+```
+
+3. **Create a Branch**: To keep your work organized, create a branch for your contribution.
+
+```bash
+git checkout -b my-branch
+```
+
+4. **Make your Changes**: Make your changes, additions, or fixes to the codebase. Remember to follow the existing code style.
+
+5. **Test your Changes**: Before committing your changes, make sure to test them to ensure they work as expected and do not introduce bugs.
+
+6. **Commit your Changes**: Commit your changes with a descriptive commit message using conventional commit messages.
+
+```bash
+git commit -m "feat: Your descriptive commit message"
+```
+
+7. **Push to your Fork**: Push your commits to the branch in your forked repository.
+
+```bash
+git push origin my-branch
+```
+
+8. **Submit a Pull Request**: Once your changes are ready to be reviewed, create a pull request from your forked repository's branch into the `main` branch of this repository.
+
+Your pull request will be reviewed and hopefully merged quickly. Thanks for contributing!

package/lib/engine/base.d.ts

@@ -0,0 +1,22 @@
+import { awscdk } from 'projen';
+import { CDKPipeline, CDKPipelineOptions, Environment } from '../pipeline';
+export interface SynthStageOptions {
+    readonly commands: string[];
+}
+export interface AssetUploadStageOptions {
+    readonly commands: string[];
+}
+export interface DeployStageOptions {
+    readonly stageName: string;
+    readonly commands: string[];
+    readonly env: Environment;
+}
+export declare abstract class BaseEngine {
+    protected app: awscdk.AwsCdkTypeScriptApp;
+    protected props: CDKPipelineOptions;
+    protected pipeline: CDKPipeline;
+    constructor(app: awscdk.AwsCdkTypeScriptApp, props: CDKPipelineOptions, pipeline: CDKPipeline);
+    abstract createSynth(options: SynthStageOptions): void;
+    abstract createAssetUpload(options: AssetUploadStageOptions): void;
+    abstract createDeployment(options: DeployStageOptions): void;
+}

package/lib/engine/base.js

@@ -0,0 +1,16 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEngine = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+class BaseEngine {
+    constructor(app, props, pipeline) {
+        this.app = app;
+        this.props = props;
+        this.pipeline = pipeline;
+    }
+}
+_a = JSII_RTTI_SYMBOL_1;
+BaseEngine[_a] = { fqn: "projen-pipelines.BaseEngine", version: "0.0.3" };
+exports.BaseEngine = BaseEngine;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9lbmdpbmUvYmFzZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQWlCQSxNQUFzQixVQUFVO0lBQzlCLFlBQXNCLEdBQStCLEVBQVksS0FBeUIsRUFBWSxRQUFxQjtRQUFyRyxRQUFHLEdBQUgsR0FBRyxDQUE0QjtRQUFZLFVBQUssR0FBTCxLQUFLLENBQW9CO1FBQVksYUFBUSxHQUFSLFFBQVEsQ0FBYTtJQUczSCxDQUFDOzs7O0FBSm1CLGdDQUFVIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgYXdzY2RrIH0gZnJvbSAncHJvamVuJztcbmltcG9ydCB7IENES1BpcGVsaW5lLCBDREtQaXBlbGluZU9wdGlvbnMsIEVudmlyb25tZW50IH0gZnJvbSAnLi4vcGlwZWxpbmUnO1xuXG5leHBvcnQgaW50ZXJmYWNlIFN5bnRoU3RhZ2VPcHRpb25zIHtcbiAgcmVhZG9ubHkgY29tbWFuZHM6IHN0cmluZ1tdO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIEFzc2V0VXBsb2FkU3RhZ2VPcHRpb25zIHtcbiAgcmVhZG9ubHkgY29tbWFuZHM6IHN0cmluZ1tdO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIERlcGxveVN0YWdlT3B0aW9ucyB7XG4gIHJlYWRvbmx5IHN0YWdlTmFtZTogc3RyaW5nO1xuICByZWFkb25seSBjb21tYW5kczogc3RyaW5nW107XG4gIHJlYWRvbmx5IGVudjogRW52aXJvbm1lbnQ7XG59XG5cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBCYXNlRW5naW5lIHtcbiAgY29uc3RydWN0b3IocHJvdGVjdGVkIGFwcDogYXdzY2RrLkF3c0Nka1R5cGVTY3JpcHRBcHAsIHByb3RlY3RlZCBwcm9wczogQ0RLUGlwZWxpbmVPcHRpb25zLCBwcm90ZWN0ZWQgcGlwZWxpbmU6IENES1BpcGVsaW5lKSB7XG5cblxuICB9XG5cbiAgYWJzdHJhY3QgY3JlYXRlU3ludGgob3B0aW9uczogU3ludGhTdGFnZU9wdGlvbnMpOiB2b2lkO1xuICBhYnN0cmFjdCBjcmVhdGVBc3NldFVwbG9hZChvcHRpb25zOiBBc3NldFVwbG9hZFN0YWdlT3B0aW9ucyk6IHZvaWQ7XG4gIGFic3RyYWN0IGNyZWF0ZURlcGxveW1lbnQob3B0aW9uczogRGVwbG95U3RhZ2VPcHRpb25zKTogdm9pZDtcblxufSJdfQ==

package/lib/engine/github.d.ts

@@ -0,0 +1,22 @@
+import { awscdk } from 'projen';
+import { AssetUploadStageOptions, BaseEngine, DeployStageOptions, SynthStageOptions } from './base';
+import { CDKPipeline, CDKPipelineOptions } from '../pipeline';
+export interface RoleMap {
+    readonly feature?: string;
+    readonly dev?: string;
+    readonly prod?: string;
+}
+export interface GithubEngineConfig {
+    readonly defaultAwsRoleArn?: string;
+    readonly awsRoleArnForSynth?: string;
+    readonly awsRoleArnForAssetPublishing?: string;
+    readonly awsRoleArnForDeployment?: RoleMap;
+}
+export declare class GitHubEngine extends BaseEngine {
+    private deploymentWorkflow;
+    private deploymentStages;
+    constructor(app: awscdk.AwsCdkTypeScriptApp, props: CDKPipelineOptions, pipeline: CDKPipeline);
+    createSynth(options: SynthStageOptions): void;
+    createAssetUpload(options: AssetUploadStageOptions): void;
+    createDeployment(options: DeployStageOptions): void;
+}

package/lib/engine/github.js

@@ -0,0 +1,100 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHubEngine = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const workflows_model_1 = require("projen/lib/github/workflows-model");
+const base_1 = require("./base");
+class GitHubEngine extends base_1.BaseEngine {
+    constructor(app, props, pipeline) {
+        super(app, props, pipeline);
+        this.deploymentStages = [];
+        this.deploymentWorkflow = this.app.github.addWorkflow('deploy');
+        this.deploymentWorkflow.on({
+            push: {
+                branches: ['main'], // TODO use defaultReleaseBranch
+            },
+            workflowDispatch: {},
+        });
+    }
+    createSynth(options) {
+        const steps = [{
+                name: 'Checkout',
+                uses: 'actions/checkout@v2',
+                env: {
+                    CI: 'true',
+                },
+            }];
+        if (this.props.githubConfig?.awsRoleArnForSynth) {
+            steps.push({
+                name: 'AWS Credentials',
+                uses: 'aws-actions/configure-aws-credentials@master',
+                with: {
+                    'role-to-assume': this.props.githubConfig.awsRoleArnForSynth,
+                    'role-session-name': 'GitHubAction',
+                    'aws-region': 'us-east-1',
+                },
+            });
+        }
+        steps.push(...options.commands.map(cmd => ({
+            run: cmd,
+        })));
+        this.deploymentWorkflow.addJob('synth', {
+            name: 'Synth CDK application',
+            runsOn: ['ubuntu-latest'],
+            permissions: { idToken: workflows_model_1.JobPermission.WRITE, contents: workflows_model_1.JobPermission.READ },
+            steps,
+        });
+    }
+    createAssetUpload(options) {
+        this.deploymentWorkflow.addJob('assetUpload', {
+            name: 'Publish assets to AWS',
+            needs: ['synth'],
+            runsOn: ['ubuntu-latest'],
+            permissions: { idToken: workflows_model_1.JobPermission.WRITE, contents: workflows_model_1.JobPermission.READ },
+            steps: [{
+                    name: 'Checkout',
+                    uses: 'actions/checkout@v2',
+                }, {
+                    name: 'AWS Credentials',
+                    uses: 'aws-actions/configure-aws-credentials@master',
+                    with: {
+                        'role-to-assume': this.props.githubConfig?.awsRoleArnForAssetPublishing ?? this.props.githubConfig?.defaultAwsRoleArn,
+                        'role-session-name': 'GitHubAction',
+                        'aws-region': 'us-east-1',
+                    },
+                },
+                ...options.commands.map(cmd => ({
+                    run: cmd,
+                }))],
+        });
+    }
+    createDeployment(options) {
+        this.deploymentWorkflow.addJob(`deploy-${options.stageName}`, {
+            name: `Deploy stage ${options.stageName} to AWS`,
+            needs: this.deploymentStages.length > 0 ? ['assetUpload', `deploy-${this.deploymentStages.at(-1)}`] : ['assetUpload'],
+            runsOn: ['ubuntu-latest'],
+            permissions: { idToken: workflows_model_1.JobPermission.WRITE, contents: workflows_model_1.JobPermission.READ },
+            steps: [{
+                    name: 'Checkout',
+                    uses: 'actions/checkout@v2',
+                }, {
+                    name: 'AWS Credentials',
+                    uses: 'aws-actions/configure-aws-credentials@master',
+                    with: {
+                        'role-to-assume': this.props.githubConfig?.awsRoleArnForDeployment?.[options.stageName] ?? this.props.githubConfig?.defaultAwsRoleArn,
+                        'role-session-name': 'GitHubAction',
+                        'aws-region': options.env.region,
+                    },
+                },
+                ...options.commands.map(cmd => ({
+                    run: cmd,
+                }))],
+        });
+        this.deploymentStages.push(options.stageName);
+    }
+}
+_a = JSII_RTTI_SYMBOL_1;
+GitHubEngine[_a] = { fqn: "projen-pipelines.GitHubEngine", version: "0.0.3" };
+exports.GitHubEngine = GitHubEngine;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"github.js","sourceRoot":"","sources":["../../src/engine/github.ts"],"names":[],"mappings":";;;;;AAEA,uEAA2E;AAC3E,iCAAoG;AAgBpG,MAAa,YAAa,SAAQ,iBAAU;IAK1C,YAAY,GAA+B,EAAE,KAAyB,EAAE,QAAqB;QAC3F,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAHtB,qBAAgB,GAAa,EAAE,CAAC;QAKtC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,MAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACjE,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACzB,IAAI,EAAE;gBACJ,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,gCAAgC;aACrD;YACD,gBAAgB,EAAE,EAAE;SACrB,CAAC,CAAC;IACL,CAAC;IAEM,WAAW,CAAC,OAA0B;QAC3C,MAAM,KAAK,GAAc,CAAC;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,qBAAqB;gBAC3B,GAAG,EAAE;oBACH,EAAE,EAAE,MAAM;iBACX;aACF,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,kBAAkB,EAAE;YAC/C,KAAK,CAAC,IAAI,CAAC;gBACT,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,8CAA8C;gBACpD,IAAI,EAAE;oBACJ,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,kBAAkB;oBAC5D,mBAAmB,EAAE,cAAc;oBACnC,YAAY,EAAE,WAAW;iBAC1B;aACF,CAAC,CAAC;SACJ;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACzC,GAAG,EAAE,GAAG;SACT,CAAC,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE;YACtC,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,CAAC,eAAe,CAAC;YACzB,WAAW,EAAE,EAAE,OAAO,EAAE,+BAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,+BAAa,CAAC,IAAI,EAAE;YAC3E,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAEM,iBAAiB,CAAC,OAAgC;QACvD,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,EAAE;YAC5C,IAAI,EAAE,uBAAuB;YAC7B,KAAK,EAAE,CAAC,OAAO,CAAC;YAChB,MAAM,EAAE,CAAC,eAAe,CAAC;YACzB,WAAW,EAAE,EAAE,OAAO,EAAE,+BAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,+BAAa,CAAC,IAAI,EAAE;YAC3E,KAAK,EAAE,CAAC;oBACN,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,qBAAqB;iBAC5B,EAAE;oBACD,IAAI,EAAE,iBAAiB;oBACvB,IAAI,EAAE,8CAA8C;oBACpD,IAAI,EAAE;wBACJ,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,4BAA4B,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,iBAAiB;wBACrH,mBAAmB,EAAE,cAAc;wBACnC,YAAY,EAAE,WAAW;qBAC1B;iBACF;gBACD,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC9B,GAAG,EAAE,GAAG;iBACT,CAAC,CAAC,CAAC;SACL,CAAC,CAAC;IACL,CAAC;IAEM,gBAAgB,CAAC,OAA2B;QACjD,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,OAAO,CAAC,SAAS,EAAE,EAAE;YAC5D,IAAI,EAAE,gBAAgB,OAAO,CAAC,SAAS,SAAS;YAChD,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,UAAU,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACtH,MAAM,EAAE,CAAC,eAAe,CAAC;YACzB,WAAW,EAAE,EAAE,OAAO,EAAE,+BAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,+BAAa,CAAC,IAAI,EAAE;YAC3E,KAAK,EAAE,CAAC;oBACN,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,qBAAqB;iBAC5B,EAAE;oBACD,IAAI,EAAE,iBAAiB;oBACvB,IAAI,EAAE,8CAA8C;oBACpD,IAAI,EAAE;wBACJ,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,uBAAuB,EAAE,CAAC,OAAO,CAAC,SAA0B,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,iBAAiB;wBACtJ,mBAAmB,EAAE,cAAc;wBACnC,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM;qBACjC;iBACF;gBACD,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC9B,GAAG,EAAE,GAAG;iBACT,CAAC,CAAC,CAAC;SACL,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;;;;AAjGU,oCAAY","sourcesContent":["import { awscdk } from 'projen';\nimport { GithubWorkflow } from 'projen/lib/github';\nimport { JobPermission, JobStep } from 'projen/lib/github/workflows-model';\nimport { AssetUploadStageOptions, BaseEngine, DeployStageOptions, SynthStageOptions } from './base';\nimport { CDKPipeline, CDKPipelineOptions } from '../pipeline';\n\nexport interface RoleMap {\n  readonly feature?: string;\n  readonly dev?: string;\n  readonly prod?: string;\n}\n\nexport interface GithubEngineConfig {\n  readonly defaultAwsRoleArn?: string;\n  readonly awsRoleArnForSynth?: string;\n  readonly awsRoleArnForAssetPublishing?: string;\n  readonly awsRoleArnForDeployment?: RoleMap;\n}\n\nexport class GitHubEngine extends BaseEngine {\n\n  private deploymentWorkflow: GithubWorkflow;\n  private deploymentStages: string[] = [];\n\n  constructor(app: awscdk.AwsCdkTypeScriptApp, props: CDKPipelineOptions, pipeline: CDKPipeline) {\n    super(app, props, pipeline);\n\n    this.deploymentWorkflow = this.app.github!.addWorkflow('deploy');\n    this.deploymentWorkflow.on({\n      push: {\n        branches: ['main'], // TODO use defaultReleaseBranch\n      },\n      workflowDispatch: {},\n    });\n  }\n\n  public createSynth(options: SynthStageOptions): void {\n    const steps: JobStep[] = [{\n      name: 'Checkout',\n      uses: 'actions/checkout@v2',\n      env: {\n        CI: 'true',\n      },\n    }];\n\n    if (this.props.githubConfig?.awsRoleArnForSynth) {\n      steps.push({\n        name: 'AWS Credentials',\n        uses: 'aws-actions/configure-aws-credentials@master',\n        with: {\n          'role-to-assume': this.props.githubConfig.awsRoleArnForSynth,\n          'role-session-name': 'GitHubAction',\n          'aws-region': 'us-east-1',\n        },\n      });\n    }\n\n    steps.push(...options.commands.map(cmd => ({\n      run: cmd,\n    })));\n\n    this.deploymentWorkflow.addJob('synth', {\n      name: 'Synth CDK application',\n      runsOn: ['ubuntu-latest'],\n      permissions: { idToken: JobPermission.WRITE, contents: JobPermission.READ },\n      steps,\n    });\n  }\n\n  public createAssetUpload(options: AssetUploadStageOptions): void {\n    this.deploymentWorkflow.addJob('assetUpload', {\n      name: 'Publish assets to AWS',\n      needs: ['synth'],\n      runsOn: ['ubuntu-latest'],\n      permissions: { idToken: JobPermission.WRITE, contents: JobPermission.READ },\n      steps: [{\n        name: 'Checkout',\n        uses: 'actions/checkout@v2',\n      }, {\n        name: 'AWS Credentials',\n        uses: 'aws-actions/configure-aws-credentials@master',\n        with: {\n          'role-to-assume': this.props.githubConfig?.awsRoleArnForAssetPublishing ?? this.props.githubConfig?.defaultAwsRoleArn,\n          'role-session-name': 'GitHubAction',\n          'aws-region': 'us-east-1',\n        },\n      },\n      ...options.commands.map(cmd => ({\n        run: cmd,\n      }))],\n    });\n  }\n\n  public createDeployment(options: DeployStageOptions): void {\n    this.deploymentWorkflow.addJob(`deploy-${options.stageName}`, {\n      name: `Deploy stage ${options.stageName} to AWS`,\n      needs: this.deploymentStages.length > 0 ? ['assetUpload', `deploy-${this.deploymentStages.at(-1)!}`] : ['assetUpload'],\n      runsOn: ['ubuntu-latest'],\n      permissions: { idToken: JobPermission.WRITE, contents: JobPermission.READ },\n      steps: [{\n        name: 'Checkout',\n        uses: 'actions/checkout@v2',\n      }, {\n        name: 'AWS Credentials',\n        uses: 'aws-actions/configure-aws-credentials@master',\n        with: {\n          'role-to-assume': this.props.githubConfig?.awsRoleArnForDeployment?.[options.stageName as keyof RoleMap] ?? this.props.githubConfig?.defaultAwsRoleArn,\n          'role-session-name': 'GitHubAction',\n          'aws-region': options.env.region,\n        },\n      },\n      ...options.commands.map(cmd => ({\n        run: cmd,\n      }))],\n    });\n    this.deploymentStages.push(options.stageName);\n  }\n}"]}

package/lib/engine/index.d.ts

@@ -0,0 +1,2 @@
+export * from './base';
+export * from './github';

package/lib/engine/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base"), exports);
+__exportStar(require("./github"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZW5naW5lL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSx5Q0FBdUI7QUFDdkIsMkNBQXlCIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSAnLi9iYXNlJztcbmV4cG9ydCAqIGZyb20gJy4vZ2l0aHViJzsiXX0=

package/lib/index.d.ts

@@ -1 +1,2 @@
 export * from './pipeline';
+export * from './engine';

package/lib/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./pipeline"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDZDQUEyQiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vcGlwZWxpbmUnOyJdfQ==
+__exportStar(require("./engine"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDZDQUEyQjtBQUMzQiwyQ0FBeUIiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL3BpcGVsaW5lJztcbmV4cG9ydCAqIGZyb20gJy4vZW5naW5lJzsiXX0=

package/lib/pipeline.d.ts

@@ -1,26 +1,154 @@
 import { Component, awscdk } from 'projen';
+import { BaseEngine, GithubEngineConfig } from './engine';
+/**
+ * The Environment interface is designed to hold AWS related information
+ * for a specific deployment environment within your infrastructure.
+ * Each environment requires a specific account and region for its resources.
+ */
 export interface Environment {
+    /**
+     * The AWS Account ID associated with the environment. It's important because
+     * different services or features could have distinct permissions and settings
+     * in different accounts.
+     */
     readonly account: string;
+    /**
+     * The AWS Region for the environment. This determines where your resources
+     * are created and where your application will run. It can affect latency,
+     * availability, and pricing.
+     */
     readonly region: string;
 }
+/**
+ * The EnvironmentMap interface is used to maintain a mapping of different types
+ * of environments used in the application. Each type of environment - personal,
+ * feature, dev, and prod, represents a different stage of development or usage.
+ */
 export interface EnvironmentMap {
+    /**
+     * The personal environment is usually used for individual development and
+     * testing, allowing developers to freely test and experiment without
+     * affecting the shared development environment.
+     */
     readonly personal: Environment;
+    /**
+     * The feature environment is typically used for developing specific features
+     * in isolation from the main codebase. This allows developers to work on
+     * individual features without impacting the stability of the dev or prod
+     * environments.
+     */
     readonly feature: Environment;
+    /**
+     * The dev environment is a shared environment where developers integrate
+     * their feature changes. It represents the latest version of the application
+     * but may not be as stable as the production environment.
+     */
     readonly dev: Environment;
+    /**
+     * The prod environment is where the live, user-facing application runs.
+     * It should be stable and only receive thoroughly tested changes.
+     */
     readonly prod: Environment;
 }
+/**
+ * The CI/CD tooling used to run your pipeline.
+ * The component will render workflows for the given system
+ */
+export declare enum PipelineEngine {
+    /** Create GitHub actions */
+    GITHUB = 0,
+    /** Create a .gitlab-ci.yaml file */
+    GITLAB = 1
+}
+/**
+ * Describes the type of pipeline that will be created
+ */
+export declare enum DeploymentType {
+    /** Deploy every commit as far as possible; hopefully into production */
+    CONTINUOUS_DEPLOYMENT = 0,
+    /** Build every commit and prepare all assets for a later deployment */
+    CONTINUOUS_DELIVERY = 1
+}
+/**
+ * The CDKPipelineOptions interface is designed to provide configuration
+ * options for a CDK (Cloud Development Kit) pipeline. It allows the definition
+ * of settings such as the stack prefix and package namespace to be used in the
+ * AWS stack, along with the environments configuration to be used.
+ */
 export interface CDKPipelineOptions {
-    readonly stackPrefix: string;
+    /**
+     * This field is used to define a prefix for the AWS Stack resources created
+     * during the pipeline's operation.
+     *
+     * @default project name
+     */
+    readonly stackPrefix?: string;
+    /**
+     * This field determines the NPM namespace to be used when packaging CDK cloud
+     * assemblies. A namespace helps group related resources together, providing
+     * better organization and ease of management.
+     */
     readonly pkgNamespace: string;
+    /**
+     * This is a map of environments to be used in the pipeline. It allows the
+     * pipeline to deploy to different environments based on the stage of the
+     * deployment process, whether that's a personal, feature, dev, or prod stage.
+     */
     readonly environments: EnvironmentMap;
+    /**
+     * This field specifies the type of pipeline to create. If set to CONTINUOUS_DEPLOYMENT,
+     * every commit is deployed as far as possible, hopefully into production. If set to
+     * CONTINUOUS_DELIVERY, every commit is built and all assets are prepared for a later deployment.
+     *
+     * @default CONTINUOUS_DELIVERY
+     */
+    readonly deploymentType?: DeploymentType;
+    /**
+     * This field determines the CI/CD tooling that will be used to run the pipeline. The component
+     * will render workflows for the given system. Options include GitHub and GitLab.
+     *
+     * @default - tries to derive it from the projects configuration
+     */
+    readonly engine?: PipelineEngine;
+    readonly githubConfig?: GithubEngineConfig;
+    readonly preInstallCommands?: string[];
+    readonly preSynthCommands?: string[];
+    readonly postSynthCommands?: string[];
 }
+/**
+ * The CDKPipeline class extends the Component class and sets up the necessary configuration for deploying AWS CDK (Cloud Development Kit) applications across multiple stages.
+ * It also manages tasks such as publishing CDK assets, bumping version based on git tags, and cleaning up conflicting tasks.
+ */
 export declare class CDKPipeline extends Component {
     private app;
     private props;
+    readonly stackPrefix: string;
+    readonly engine: BaseEngine;
     constructor(app: awscdk.AwsCdkTypeScriptApp, props: CDKPipelineOptions);
+    private createSynthStage;
+    /**
+     * This method generates the entry point for the application, including interfaces and classes
+     * necessary to set up the pipeline and define the AWS CDK stacks for different environments.
+     */
     private createApplicationEntrypoint;
+    /**
+     * This method sets up tasks to publish CDK assets to all accounts and handle versioning, including bumping the version
+     * based on the latest git tag and pushing the CDK assembly to the package repository.
+     */
     private createReleaseTasks;
+    /**
+     * This method sets up tasks for the personal deployment stage, including deployment, watching for changes,
+     * comparing changes (diff), and destroying the stack when no longer needed.
+     */
     private createPersonalStage;
+    /**
+     * This method sets up tasks for the feature deployment stage, including deployment, comparing changes (diff),
+     * and destroying the stack when no longer needed.
+     */
     private createFeatureStage;
+    /**
+     * This method sets up tasks for the general pipeline stages (dev, prod), including deployment and comparing changes (diff).
+     * @param {string} stageName - The name of the stage (e.g., 'dev', 'prod')
+     */
     private createPipelineStage;
 }