projen-pipelines 0.0.1 → 0.0.3

package/.jsii

@@ -73,7 +73,7 @@
   },
   "name": "projen-pipelines",
   "readme": {
-    "markdown": "# replace this"
+    "markdown": "# Projen Pipelines\n\n[![npm version](https://badge.fury.io/js/projen-pipelines.svg)](https://www.npmjs.com/package/projen-pipelines)\n\n\nProjen Pipelines is a projen library that provides high-level abstractions for defining continuous delivery (CD) pipelines for AWS CDK applications.\nIt is specifically designed to work with the projen project configuration engine.\n\nThis library provides high-level abstractions for defining multi-environment and multi-account AWS CDK applications with ease.\nWith this library, you can handle complex deployment scenarios with less code and manage your AWS infrastructure in a more efficient and straightforward way.\n\n## Getting Started\n\n### Installation\n\nTo install the package, add the package `projen-pipelines` to your projects devDeps in your projen configuration file.\n\n\nAfter installing the package, you can import and use the constructs to define your CDK Pipelines.\n\n### Usage\n\nYou can start using the constructs provided by Projen Pipelines in your AWS CDK applications. Here's a brief example:\n\n```typescript\nimport { awscdk } from 'projen';\nimport { CDKPipeline, CDKPipelineOptions } from 'projen-pipelines';\n\n// Define your AWS CDK TypeScript App\nconst app = new awscdk.AwsCdkTypeScriptApp({\n  cdkVersion: '2.80.0',\n  name: 'my-awesome-app',\n  defaultReleaseBranch: 'main',\n  devDeps: [\n    'projen-pipelines',\n  ],\n});\n\n// Create the pipeline\nnew CDKPipeline(app, {\n  stackPrefix: 'MyApp',\n  pkgNamespace: '@company-assemblies',\n  environments: {\n    dev: { account: '111111111111', region: 'eu-central-1' },\n    prod: { account: '222222222222', region: 'eu-central-1' },\n  },\n});\n```\n\nAfter running projen (`npx projen`) a new file called `src/app.ts` will be created and contain a specialized CDK App class for your project.\n\nYou can then use this in your `main.ts` to configure your deployment.\n\n```typescript\nimport { PipelineApp } from './app';\nimport { BackendStack } from './stack';\n\nconst app = new PipelineApp({\n  provideDevStack: (scope, id, props) => {\n    return new BackendStack(scope, id, {\n      ...props,\n      apiHostname: 'api-dev',\n      myConfigSetting: 'value-for-dev',\n    });\n  },\n  provideProdStack: (scope, id, props) => {\n    return new BackendStack(scope, id, {\n      ...props,\n      apiHostname: 'api',\n      myConfigSetting: 'value-for-prod',\n    });\n  },\n  providePersonalStack: (scope, id, props) => {\n    return new BackendStack(scope, id, {\n      ...props,\n      apiHostname: `api-${props.stageName}`,\n      myConfigSetting: 'value-for-personal-stage',\n    });\n  },\n});\n\napp.synth();\n```\n\n### Deployment\n\nThe `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.\n\nHere's a brief description of each one:\n\n1. **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.\n\n2. **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.\n\n3. **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.\n\n4. **destroy:personal** - This task destroys the resources created for the personal stage of the application.\n\n5. **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.\n\n6. **diff:feature** - This task is similar to `diff:personal`, but for the feature stage.\n\n7. **destroy:feature** - This task destroys the resources created for the feature stage of the application.\n\n8. **deploy:<stageName>** - This task deploys a specific stage of the application (like 'dev' or 'prod').\n\n9. **diff:<stageName>** - This task compares the specified application stage with the current state of the application code.\n\n10. **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.\n\n11. **bump** - This task bumps the version based on the latest git tag and pushes the updated tag to the git repository.\n\n12. **release:push-assembly** - This task creates a manifest, bumps the version without creating a git tag, and publishes the cloud assembly to your registry.\n\nRemember that these tasks are created and managed automatically by the `CDKPipeline` class. You can run these tasks using the `npx projen TASK_NAME` command.\n\n\n## Contributing\n\nWe welcome all contributions to Projen Pipelines! Here's how you can get started:\n\n1. **Fork the Repository**: Click the 'Fork' button at the top right of this page to duplicate this repository in your GitHub account.\n\n2. **Clone your Fork**: Clone the forked repository to your local machine.\n\n```bash\ngit clone https://github.com/<your_username>/projen-pipelines.git\n```\n\n3. **Create a Branch**: To keep your work organized, create a branch for your contribution.\n\n```bash\ngit checkout -b my-branch\n```\n\n4. **Make your Changes**: Make your changes, additions, or fixes to the codebase. Remember to follow the existing code style.\n\n5. **Test your Changes**: Before committing your changes, make sure to test them to ensure they work as expected and do not introduce bugs.\n\n6. **Commit your Changes**: Commit your changes with a descriptive commit message using conventional commit messages.\n\n```bash\ngit commit -m \"feat: Your descriptive commit message\"\n```\n\n7. **Push to your Fork**: Push your commits to the branch in your forked repository.\n\n```bash\ngit push origin my-branch\n```\n\n8. **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.\n\nYour pull request will be reviewed and hopefully merged quickly. Thanks for contributing!\n"
   },
   "repository": {
     "type": "git",
@@ -86,11 +86,197 @@
     }
   },
   "types": {
+    "projen-pipelines.AssetUploadStageOptions": {
+      "assembly": "projen-pipelines",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "projen-pipelines.AssetUploadStageOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/engine/base.ts",
+        "line": 8
+      },
+      "name": "AssetUploadStageOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 9
+          },
+          "name": "commands",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/engine/base:AssetUploadStageOptions"
+    },
+    "projen-pipelines.BaseEngine": {
+      "abstract": true,
+      "assembly": "projen-pipelines",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "projen-pipelines.BaseEngine",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/engine/base.ts",
+          "line": 19
+        },
+        "parameters": [
+          {
+            "name": "app",
+            "type": {
+              "fqn": "projen.awscdk.AwsCdkTypeScriptApp"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "projen-pipelines.CDKPipelineOptions"
+            }
+          },
+          {
+            "name": "pipeline",
+            "type": {
+              "fqn": "projen-pipelines.CDKPipeline"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/engine/base.ts",
+        "line": 18
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 25
+          },
+          "name": "createAssetUpload",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "projen-pipelines.AssetUploadStageOptions"
+              }
+            }
+          ]
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 26
+          },
+          "name": "createDeployment",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "projen-pipelines.DeployStageOptions"
+              }
+            }
+          ]
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 24
+          },
+          "name": "createSynth",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "projen-pipelines.SynthStageOptions"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "BaseEngine",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 19
+          },
+          "name": "app",
+          "protected": true,
+          "type": {
+            "fqn": "projen.awscdk.AwsCdkTypeScriptApp"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 19
+          },
+          "name": "pipeline",
+          "protected": true,
+          "type": {
+            "fqn": "projen-pipelines.CDKPipeline"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 19
+          },
+          "name": "props",
+          "protected": true,
+          "type": {
+            "fqn": "projen-pipelines.CDKPipelineOptions"
+          }
+        }
+      ],
+      "symbolId": "src/engine/base:BaseEngine"
+    },
     "projen-pipelines.CDKPipeline": {
       "assembly": "projen-pipelines",
       "base": "projen.Component",
       "docs": {
-        "stability": "stable"
+        "remarks": "It also manages tasks such as publishing CDK assets, bumping version based on git tags, and cleaning up conflicting tasks.",
+        "stability": "stable",
+        "summary": "The CDKPipeline class extends the Component class and sets up the necessary configuration for deploying AWS CDK (Cloud Development Kit) applications across multiple stages."
       },
       "fqn": "projen-pipelines.CDKPipeline",
       "initializer": {
@@ -99,7 +285,7 @@
         },
         "locationInModule": {
           "filename": "src/pipeline.ts",
-          "line": 24
+          "line": 148
         },
         "parameters": [
           {
@@ -119,34 +305,68 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/pipeline.ts",
-        "line": 22
+        "line": 143
       },
       "name": "CDKPipeline",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 146
+          },
+          "name": "engine",
+          "type": {
+            "fqn": "projen-pipelines.BaseEngine"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 145
+          },
+          "name": "stackPrefix",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
       "symbolId": "src/pipeline:CDKPipeline"
     },
     "projen-pipelines.CDKPipelineOptions": {
       "assembly": "projen-pipelines",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "remarks": "It allows the definition\nof settings such as the stack prefix and package namespace to be used in the\nAWS stack, along with the environments configuration to be used.",
+        "stability": "stable",
+        "summary": "The CDKPipelineOptions interface is designed to provide configuration options for a CDK (Cloud Development Kit) pipeline."
       },
       "fqn": "projen-pipelines.CDKPipelineOptions",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/pipeline.ts",
-        "line": 16
+        "line": 90
       },
       "name": "CDKPipelineOptions",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "It allows the\npipeline to deploy to different environments based on the stage of the\ndeployment process, whether that's a personal, feature, dev, or prod stage.",
+            "stability": "stable",
+            "summary": "This is a map of environments to be used in the pipeline."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 19
+            "line": 112
           },
           "name": "environments",
           "type": {
@@ -156,18 +376,58 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "A namespace helps group related resources together, providing\nbetter organization and ease of management.",
+            "stability": "stable",
+            "summary": "This field determines the NPM namespace to be used when packaging CDK cloud assemblies."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 18
+            "line": 105
           },
           "name": "pkgNamespace",
           "type": {
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "CONTINUOUS_DELIVERY",
+            "remarks": "If set to CONTINUOUS_DEPLOYMENT,\nevery commit is deployed as far as possible, hopefully into production. If set to\nCONTINUOUS_DELIVERY, every commit is built and all assets are prepared for a later deployment.",
+            "stability": "stable",
+            "summary": "This field specifies the type of pipeline to create."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 121
+          },
+          "name": "deploymentType",
+          "optional": true,
+          "type": {
+            "fqn": "projen-pipelines.DeploymentType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- tries to derive it from the projects configuration",
+            "remarks": "The component\nwill render workflows for the given system. Options include GitHub and GitLab.",
+            "stability": "stable",
+            "summary": "This field determines the CI/CD tooling that will be used to run the pipeline."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 129
+          },
+          "name": "engine",
+          "optional": true,
+          "type": {
+            "fqn": "projen-pipelines.PipelineEngine"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -176,9 +436,91 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 17
+            "line": 131
+          },
+          "name": "githubConfig",
+          "optional": true,
+          "type": {
+            "fqn": "projen-pipelines.GithubEngineConfig"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 135
+          },
+          "name": "postSynthCommands",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 133
+          },
+          "name": "preInstallCommands",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 134
+          },
+          "name": "preSynthCommands",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "project name",
+            "stability": "stable",
+            "summary": "This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/pipeline.ts",
+            "line": 98
           },
           "name": "stackPrefix",
+          "optional": true,
           "type": {
             "primitive": "string"
           }
@@ -186,29 +528,132 @@
       ],
       "symbolId": "src/pipeline:CDKPipelineOptions"
     },
-    "projen-pipelines.Environment": {
+    "projen-pipelines.DeployStageOptions": {
       "assembly": "projen-pipelines",
       "datatype": true,
       "docs": {
         "stability": "stable"
       },
+      "fqn": "projen-pipelines.DeployStageOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/engine/base.ts",
+        "line": 12
+      },
+      "name": "DeployStageOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 14
+          },
+          "name": "commands",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 15
+          },
+          "name": "env",
+          "type": {
+            "fqn": "projen-pipelines.Environment"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 13
+          },
+          "name": "stageName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/engine/base:DeployStageOptions"
+    },
+    "projen-pipelines.DeploymentType": {
+      "assembly": "projen-pipelines",
+      "docs": {
+        "stability": "stable",
+        "summary": "Describes the type of pipeline that will be created."
+      },
+      "fqn": "projen-pipelines.DeploymentType",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/pipeline.ts",
+        "line": 77
+      },
+      "members": [
+        {
+          "docs": {
+            "remarks": "hopefully into production",
+            "stability": "stable",
+            "summary": "Deploy every commit as far as possible;"
+          },
+          "name": "CONTINUOUS_DEPLOYMENT"
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Build every commit and prepare all assets for a later deployment."
+          },
+          "name": "CONTINUOUS_DELIVERY"
+        }
+      ],
+      "name": "DeploymentType",
+      "symbolId": "src/pipeline:DeploymentType"
+    },
+    "projen-pipelines.Environment": {
+      "assembly": "projen-pipelines",
+      "datatype": true,
+      "docs": {
+        "remarks": "Each environment requires a specific account and region for its resources.",
+        "stability": "stable",
+        "summary": "The Environment interface is designed to hold AWS related information for a specific deployment environment within your infrastructure."
+      },
       "fqn": "projen-pipelines.Environment",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/pipeline.ts",
-        "line": 4
+        "line": 10
       },
       "name": "Environment",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "It's important because\ndifferent services or features could have distinct permissions and settings\nin different accounts.",
+            "stability": "stable",
+            "summary": "The AWS Account ID associated with the environment."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 5
+            "line": 16
           },
           "name": "account",
           "type": {
@@ -218,12 +663,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "This determines where your resources\nare created and where your application will run. It can affect latency,\navailability, and pricing.",
+            "stability": "stable",
+            "summary": "The AWS Region for the environment."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 6
+            "line": 23
           },
           "name": "region",
           "type": {
@@ -237,25 +684,29 @@
       "assembly": "projen-pipelines",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "remarks": "Each type of environment - personal,\nfeature, dev, and prod, represents a different stage of development or usage.",
+        "stability": "stable",
+        "summary": "The EnvironmentMap interface is used to maintain a mapping of different types of environments used in the application."
       },
       "fqn": "projen-pipelines.EnvironmentMap",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/pipeline.ts",
-        "line": 9
+        "line": 31
       },
       "name": "EnvironmentMap",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "It represents the latest version of the application\nbut may not be as stable as the production environment.",
+            "stability": "stable",
+            "summary": "The dev environment is a shared environment where developers integrate their feature changes."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 12
+            "line": 52
           },
           "name": "dev",
           "type": {
@@ -265,12 +716,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "This allows developers to work on\nindividual features without impacting the stability of the dev or prod\nenvironments.",
+            "stability": "stable",
+            "summary": "The feature environment is typically used for developing specific features in isolation from the main codebase."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 11
+            "line": 45
           },
           "name": "feature",
           "type": {
@@ -280,12 +733,13 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "The personal environment is usually used for individual development and testing, allowing developers to freely test and experiment without affecting the shared development environment."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 10
+            "line": 37
           },
           "name": "personal",
           "type": {
@@ -295,12 +749,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "It should be stable and only receive thoroughly tested changes.",
+            "stability": "stable",
+            "summary": "The prod environment is where the live, user-facing application runs."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/pipeline.ts",
-            "line": 13
+            "line": 58
           },
           "name": "prod",
           "type": {
@@ -309,8 +765,326 @@
         }
       ],
       "symbolId": "src/pipeline:EnvironmentMap"
+    },
+    "projen-pipelines.GitHubEngine": {
+      "assembly": "projen-pipelines",
+      "base": "projen-pipelines.BaseEngine",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "projen-pipelines.GitHubEngine",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/engine/github.ts",
+          "line": 25
+        },
+        "parameters": [
+          {
+            "name": "app",
+            "type": {
+              "fqn": "projen.awscdk.AwsCdkTypeScriptApp"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "projen-pipelines.CDKPipelineOptions"
+            }
+          },
+          {
+            "name": "pipeline",
+            "type": {
+              "fqn": "projen-pipelines.CDKPipeline"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/engine/github.ts",
+        "line": 20
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 70
+          },
+          "name": "createAssetUpload",
+          "overrides": "projen-pipelines.BaseEngine",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "projen-pipelines.AssetUploadStageOptions"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 94
+          },
+          "name": "createDeployment",
+          "overrides": "projen-pipelines.BaseEngine",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "projen-pipelines.DeployStageOptions"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 37
+          },
+          "name": "createSynth",
+          "overrides": "projen-pipelines.BaseEngine",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "projen-pipelines.SynthStageOptions"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "GitHubEngine",
+      "symbolId": "src/engine/github:GitHubEngine"
+    },
+    "projen-pipelines.GithubEngineConfig": {
+      "assembly": "projen-pipelines",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "projen-pipelines.GithubEngineConfig",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/engine/github.ts",
+        "line": 13
+      },
+      "name": "GithubEngineConfig",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 16
+          },
+          "name": "awsRoleArnForAssetPublishing",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 17
+          },
+          "name": "awsRoleArnForDeployment",
+          "optional": true,
+          "type": {
+            "fqn": "projen-pipelines.RoleMap"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 15
+          },
+          "name": "awsRoleArnForSynth",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 14
+          },
+          "name": "defaultAwsRoleArn",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/engine/github:GithubEngineConfig"
+    },
+    "projen-pipelines.PipelineEngine": {
+      "assembly": "projen-pipelines",
+      "docs": {
+        "remarks": "The component will render workflows for the given system",
+        "stability": "stable",
+        "summary": "The CI/CD tooling used to run your pipeline."
+      },
+      "fqn": "projen-pipelines.PipelineEngine",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/pipeline.ts",
+        "line": 65
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create GitHub actions."
+          },
+          "name": "GITHUB"
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a .gitlab-ci.yaml file."
+          },
+          "name": "GITLAB"
+        }
+      ],
+      "name": "PipelineEngine",
+      "symbolId": "src/pipeline:PipelineEngine"
+    },
+    "projen-pipelines.RoleMap": {
+      "assembly": "projen-pipelines",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "projen-pipelines.RoleMap",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/engine/github.ts",
+        "line": 7
+      },
+      "name": "RoleMap",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 9
+          },
+          "name": "dev",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 8
+          },
+          "name": "feature",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/github.ts",
+            "line": 10
+          },
+          "name": "prod",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/engine/github:RoleMap"
+    },
+    "projen-pipelines.SynthStageOptions": {
+      "assembly": "projen-pipelines",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "projen-pipelines.SynthStageOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/engine/base.ts",
+        "line": 4
+      },
+      "name": "SynthStageOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/engine/base.ts",
+            "line": 5
+          },
+          "name": "commands",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/engine/base:SynthStageOptions"
     }
   },
-  "version": "0.0.1",
-  "fingerprint": "2LYbS7mnYEB7BvVsmfx7xZ2z3b2bi5G6OW2IkIWWAjs="
+  "version": "0.0.3",
+  "fingerprint": "zkSpz+00oPE+CdLfNnDocGKgRO0gLHx9pa6gSRAVRYg="
 }