projen 0.34.25 → 0.35.0

package/.jsii

@@ -245,7 +245,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk-construct.ts",
-            "line": 177
+            "line": 178
           },
           "name": "addCdkDependencies",
           "parameters": [
@@ -269,7 +269,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk-construct.ts",
-            "line": 193
+            "line": 194
           },
           "name": "addCdkTestDependencies",
           "parameters": [
@@ -327,7 +327,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk-construct.ts",
-            "line": 160
+            "line": 161
           },
           "name": "version",
           "type": {
@@ -580,7 +580,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk-app-ts.ts",
-            "line": 166
+            "line": 181
           },
           "name": "addCdkDependency",
           "parameters": [
@@ -1374,7 +1374,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/awscdk-construct.ts",
-        "line": 206
+        "line": 207
       },
       "name": "ConstructLibraryAws",
       "symbolId": "src/awscdk-construct:ConstructLibraryAws"
@@ -1393,7 +1393,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk-construct.ts",
-        "line": 203
+        "line": 204
       },
       "name": "ConstructLibraryAwsOptions",
       "symbolId": "src/awscdk-construct:ConstructLibraryAwsOptions"
@@ -17165,7 +17165,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/awscdk/cdk-config.ts",
-        "line": 97
+        "line": 115
       },
       "members": [
         {
@@ -17209,7 +17209,7 @@
         },
         "locationInModule": {
           "filename": "src/awscdk/auto-discover.ts",
-          "line": 30
+          "line": 36
         },
         "parameters": [
           {
@@ -17229,7 +17229,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/awscdk/auto-discover.ts",
-        "line": 27
+        "line": 33
       },
       "name": "AutoDiscover",
       "namespace": "awscdk",
@@ -17246,7 +17246,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/auto-discover.ts",
-        "line": 11
+        "line": 12
       },
       "name": "AutoDiscoverOptions",
       "namespace": "awscdk",
@@ -17260,13 +17260,29 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/auto-discover.ts",
-            "line": 20
+            "line": 21
           },
           "name": "srcdir",
           "type": {
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Test source tree."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/auto-discover.ts",
+            "line": 26
+          },
+          "name": "testdir",
+          "type": {
+            "primitive": "string"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -17276,7 +17292,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/auto-discover.ts",
-            "line": 15
+            "line": 16
           },
           "name": "lambdaOptions",
           "optional": true,
@@ -17539,7 +17555,7 @@
         },
         "locationInModule": {
           "filename": "src/awscdk/cdk-config.ts",
-          "line": 66
+          "line": 80
         },
         "parameters": [
           {
@@ -17559,7 +17575,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/awscdk/cdk-config.ts",
-        "line": 54
+        "line": 68
       },
       "name": "CdkConfig",
       "namespace": "awscdk",
@@ -17572,7 +17588,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/cdk-config.ts",
-            "line": 64
+            "line": 78
           },
           "name": "cdkout",
           "type": {
@@ -17587,7 +17603,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/cdk-config.ts",
-            "line": 59
+            "line": 73
           },
           "name": "json",
           "type": {
@@ -17689,6 +17705,52 @@
           "type": {
             "fqn": "projen.awscdk.ApprovalLevel"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[]",
+            "stability": "experimental",
+            "summary": "Glob patterns to exclude from `cdk watch`."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/cdk-config.ts",
+            "line": 51
+          },
+          "name": "watchExcludes",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[]",
+            "stability": "experimental",
+            "summary": "Glob patterns to include in `cdk watch`."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/cdk-config.ts",
+            "line": 44
+          },
+          "name": "watchIncludes",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/awscdk/cdk-config:CdkConfigCommonOptions"
@@ -17707,7 +17769,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/cdk-config.ts",
-        "line": 43
+        "line": 57
       },
       "name": "CdkConfigOptions",
       "namespace": "awscdk",
@@ -17721,7 +17783,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/cdk-config.ts",
-            "line": 48
+            "line": 62
           },
           "name": "app",
           "type": {
@@ -17827,6 +17889,200 @@
       ],
       "symbolId": "src/awscdk/cdk-tasks:CdkTasks"
     },
+    "projen.awscdk.IntegrationTest": {
+      "assembly": "projen",
+      "base": "projen.Component",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Cloud integration tests."
+      },
+      "fqn": "projen.awscdk.IntegrationTest",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/awscdk/integration-test.ts",
+          "line": 60
+        },
+        "parameters": [
+          {
+            "name": "project",
+            "type": {
+              "fqn": "projen.Project"
+            }
+          },
+          {
+            "name": "options",
+            "type": {
+              "fqn": "projen.awscdk.IntegrationTestOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/awscdk/integration-test.ts",
+        "line": 34
+      },
+      "name": "IntegrationTest",
+      "namespace": "awscdk",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Synthesizes the integration test and compares against a local copy (runs during build)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/integration-test.ts",
+            "line": 48
+          },
+          "name": "assertTask",
+          "type": {
+            "fqn": "projen.tasks.Task"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Deploy the integration test and update the snapshot upon success."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/integration-test.ts",
+            "line": 38
+          },
+          "name": "deployTask",
+          "type": {
+            "fqn": "projen.tasks.Task"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Destroys a deployed stack."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/integration-test.ts",
+            "line": 43
+          },
+          "name": "destroyTask",
+          "type": {
+            "fqn": "projen.tasks.Task"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Just update snapshot (without deployment)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/integration-test.ts",
+            "line": 53
+          },
+          "name": "snapshotTask",
+          "type": {
+            "fqn": "projen.tasks.Task"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The watch task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/integration-test.ts",
+            "line": 58
+          },
+          "name": "watchTask",
+          "type": {
+            "fqn": "projen.tasks.Task"
+          }
+        }
+      ],
+      "symbolId": "src/awscdk/integration-test:IntegrationTest"
+    },
+    "projen.awscdk.IntegrationTestCommonOptions": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "projen.awscdk.IntegrationTestCommonOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/awscdk/integration-test.ts",
+        "line": 7
+      },
+      "name": "IntegrationTestCommonOptions",
+      "namespace": "awscdk",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "remarks": "If disabled, leaves the\napp deployed in the dev account.",
+            "stability": "experimental",
+            "summary": "Destroy the test app after a successful deployment."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/integration-test.ts",
+            "line": 13
+          },
+          "name": "destroyAfterDeploy",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/awscdk/integration-test:IntegrationTestCommonOptions"
+    },
+    "projen.awscdk.IntegrationTestOptions": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Options for `IntegrationTest`."
+      },
+      "fqn": "projen.awscdk.IntegrationTestOptions",
+      "interfaces": [
+        "projen.awscdk.IntegrationTestCommonOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/awscdk/integration-test.ts",
+        "line": 19
+      },
+      "name": "IntegrationTestOptions",
+      "namespace": "awscdk",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "example": "\"test/subdir/foo.integ.ts\"",
+            "remarks": "This is relative to the root directory of the project.",
+            "stability": "experimental",
+            "summary": "A path from the project root directory to a TypeScript file which contains the integration test app."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/integration-test.ts",
+            "line": 28
+          },
+          "name": "entrypoint",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/awscdk/integration-test:IntegrationTestOptions"
+    },
     "projen.awscdk.LambdaFunction": {
       "assembly": "projen",
       "base": "projen.Component",
@@ -34411,6 +34667,6 @@
       "symbolId": "src/web/tailwind:TailwindConfigOptions"
     }
   },
-  "version": "0.34.25",
-  "fingerprint": "XsTL86r6/nItWcVqzwDJe4JBoVeAl1bkrRbHBf0My5A="
+  "version": "0.35.0",
+  "fingerprint": "oYNSctgM+Rh2+hefjMJ6Q7BlJXkN6AqKzTsjGcPgkds="
 }

package/API.md

@@ -53,6 +53,7 @@ Name|Description
 [awscdk.AwsCdkJavaApp](#projen-awscdk-awscdkjavaapp)|AWS CDK app in Java.
 [awscdk.CdkConfig](#projen-awscdk-cdkconfig)|Represents cdk.json file.
 [awscdk.CdkTasks](#projen-awscdk-cdktasks)|Adds standard AWS CDK tasks to your project.
+[awscdk.IntegrationTest](#projen-awscdk-integrationtest)|Cloud integration tests.
 [awscdk.LambdaFunction](#projen-awscdk-lambdafunction)|Generates a pre-bundled AWS Lambda function construct from handler code.
 [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)|The runtime for the AWS Lambda function.
 [deps.Dependencies](#projen-deps-dependencies)|The `Dependencies` component is responsible to track the list of dependencies a project has, and then used by project types as the model for rendering project-specific dependency manifests such as the dependencies section `package.json` files.
@@ -182,6 +183,8 @@ Name|Description
 [awscdk.AwsCdkJavaAppOptions](#projen-awscdk-awscdkjavaappoptions)|*No description*
 [awscdk.CdkConfigCommonOptions](#projen-awscdk-cdkconfigcommonoptions)|Common options for `cdk.json`.
 [awscdk.CdkConfigOptions](#projen-awscdk-cdkconfigoptions)|Options for `CdkJson`.
+[awscdk.IntegrationTestCommonOptions](#projen-awscdk-integrationtestcommonoptions)|*No description*
+[awscdk.IntegrationTestOptions](#projen-awscdk-integrationtestoptions)|Options for `IntegrationTest`.
 [awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)|Common options for `LambdaFunction`.
 [awscdk.LambdaFunctionOptions](#projen-awscdk-lambdafunctionoptions)|Options for `Function`.
 [deps.Dependency](#projen-deps-dependency)|Represents a project dependency.
@@ -674,6 +677,8 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
   * **context** (<code>Map<string, string></code>)  Additional context to include in `cdk.json`. __*Default*__: no additional context
   * **featureFlags** (<code>boolean</code>)  Include all feature flags in cdk.json. __*Default*__: true
   * **requireApproval** (<code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code>)  To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
+  * **watchExcludes** (<code>Array<string></code>)  Glob patterns to exclude from `cdk watch`. __*Default*__: []
+  * **watchIncludes** (<code>Array<string></code>)  Glob patterns to include in `cdk watch`. __*Default*__: []
   * **cdkVersion** (<code>string</code>)  AWS CDK version to use. 
   * **appEntrypoint** (<code>string</code>)  The CDK app's entrypoint (relative to the source directory, which is "src" by default). __*Default*__: "main.ts"
   * **cdkDependencies** (<code>Array<string></code>)  Which AWS CDK modules (those that start with "@aws-cdk/") this app uses. __*Optional*__
@@ -5175,6 +5180,7 @@ new awscdk.AutoDiscover(project: Project, options: AutoDiscoverOptions)
 * **project** (<code>[Project](#projen-project)</code>)  *No description*
 * **options** (<code>[awscdk.AutoDiscoverOptions](#projen-awscdk-autodiscoveroptions)</code>)  *No description*
   * **srcdir** (<code>string</code>)  Project source tree (relative to project output directory). 
+  * **testdir** (<code>string</code>)  Test source tree. 
   * **lambdaOptions** (<code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code>)  Options for auto-discovery of AWS Lambda functions. __*Optional*__
 
 
@@ -5240,6 +5246,8 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
   * **context** (<code>Map<string, string></code>)  Additional context to include in `cdk.json`. __*Default*__: no additional context
   * **featureFlags** (<code>boolean</code>)  Include all feature flags in cdk.json. __*Default*__: true
   * **requireApproval** (<code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code>)  To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
+  * **watchExcludes** (<code>Array<string></code>)  Glob patterns to exclude from `cdk watch`. __*Default*__: []
+  * **watchIncludes** (<code>Array<string></code>)  Glob patterns to include in `cdk watch`. __*Default*__: []
   * **cdkVersion** (<code>string</code>)  AWS CDK version to use (you can use semantic versioning). 
   * **mainClass** (<code>string</code>)  The name of the Java class with the static `main()` method. 
   * **cdkDependencies** (<code>Array<string></code>)  Which AWS CDK modules this app uses. __*Optional*__
@@ -5299,6 +5307,8 @@ new awscdk.CdkConfig(project: Project, options: CdkConfigOptions)
   * **context** (<code>Map<string, string></code>)  Additional context to include in `cdk.json`. __*Default*__: no additional context
   * **featureFlags** (<code>boolean</code>)  Include all feature flags in cdk.json. __*Default*__: true
   * **requireApproval** (<code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code>)  To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
+  * **watchExcludes** (<code>Array<string></code>)  Glob patterns to exclude from `cdk watch`. __*Default*__: []
+  * **watchIncludes** (<code>Array<string></code>)  Glob patterns to include in `cdk watch`. __*Default*__: []
   * **app** (<code>string</code>)  The command line to execute in order to synthesize the CDK application (language specific). 
 
 
@@ -5346,6 +5356,43 @@ Name | Type | Description
 
 
 
+## class IntegrationTest 🔹 <a id="projen-awscdk-integrationtest"></a>
+
+Cloud integration tests.
+
+__Submodule__: awscdk
+
+__Extends__: [Component](#projen-component)
+
+### Initializer
+
+
+
+
+```ts
+new awscdk.IntegrationTest(project: Project, options: IntegrationTestOptions)
+```
+
+* **project** (<code>[Project](#projen-project)</code>)  *No description*
+* **options** (<code>[awscdk.IntegrationTestOptions](#projen-awscdk-integrationtestoptions)</code>)  *No description*
+  * **destroyAfterDeploy** (<code>boolean</code>)  Destroy the test app after a successful deployment. __*Default*__: true
+  * **entrypoint** (<code>string</code>)  A path from the project root directory to a TypeScript file which contains the integration test app. 
+
+
+
+### Properties
+
+
+Name | Type | Description 
+-----|------|-------------
+**assertTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Synthesizes the integration test and compares against a local copy (runs during build).
+**deployTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Deploy the integration test and update the snapshot upon success.
+**destroyTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Destroys a deployed stack.
+**snapshotTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Just update snapshot (without deployment).
+**watchTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The watch task.
+
+
+
 ## class LambdaFunction 🔹 <a id="projen-awscdk-lambdafunction"></a>
 
 Generates a pre-bundled AWS Lambda function construct from handler code.
@@ -9200,6 +9247,8 @@ Name | Type | Description
 **typescriptVersion**?🔹 | <code>string</code> | TypeScript version to use.<br/>__*Default*__: "latest"
 **versionrcOptions**?🔹 | <code>Map<string, any></code> | Custom configuration used when creating changelog with standard-version package.<br/>__*Default*__: standard configuration applicable for GitHub repositories
 **vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
+**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
+**watchIncludes**?🔹 | <code>Array<string></code> | Glob patterns to include in `cdk watch`.<br/>__*Default*__: []
 **workflowBootstrapSteps**?🔹 | <code>Array<any></code> | Workflow steps to use in order to bootstrap this repo.<br/>__*Default*__: "yarn install --frozen-lockfile && yarn projen"
 **workflowContainerImage**?🔹 | <code>string</code> | Container image to use for GitHub workflows.<br/>__*Default*__: default image
 **workflowGitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use in workflows.<br/>__*Default*__: GitHub Actions
@@ -11697,6 +11746,7 @@ Options for `AutoDiscover`.
 Name | Type | Description 
 -----|------|-------------
 **srcdir**🔹 | <code>string</code> | Project source tree (relative to project output directory).
+**testdir**🔹 | <code>string</code> | Test source tree.
 **lambdaOptions**?🔹 | <code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code> | Options for auto-discovery of AWS Lambda functions.<br/>__*Optional*__
 
 
@@ -11755,6 +11805,8 @@ Name | Type | Description
 **testDeps**?🔹 | <code>Array<string></code> | List of test dependencies for this project.<br/>__*Default*__: []
 **url**?🔹 | <code>string</code> | The URL, like the name, is not required.<br/>__*Default*__: undefined
 **vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
+**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
+**watchIncludes**?🔹 | <code>Array<string></code> | Glob patterns to include in `cdk watch`.<br/>__*Default*__: []
 
 
 
@@ -11771,6 +11823,8 @@ Name | Type | Description
 **context**?🔹 | <code>Map<string, string></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
 **featureFlags**?🔹 | <code>boolean</code> | Include all feature flags in cdk.json.<br/>__*Default*__: true
 **requireApproval**?🔹 | <code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.<br/>__*Default*__: ApprovalLevel.BROADENING
+**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
+**watchIncludes**?🔹 | <code>Array<string></code> | Glob patterns to include in `cdk watch`.<br/>__*Default*__: []
 
 
 
@@ -11788,6 +11842,35 @@ Name | Type | Description
 **context**?🔹 | <code>Map<string, string></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
 **featureFlags**?🔹 | <code>boolean</code> | Include all feature flags in cdk.json.<br/>__*Default*__: true
 **requireApproval**?🔹 | <code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.<br/>__*Default*__: ApprovalLevel.BROADENING
+**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
+**watchIncludes**?🔹 | <code>Array<string></code> | Glob patterns to include in `cdk watch`.<br/>__*Default*__: []
+
+
+
+## struct IntegrationTestCommonOptions 🔹 <a id="projen-awscdk-integrationtestcommonoptions"></a>
+
+
+
+
+
+
+Name | Type | Description 
+-----|------|-------------
+**destroyAfterDeploy**?🔹 | <code>boolean</code> | Destroy the test app after a successful deployment.<br/>__*Default*__: true
+
+
+
+## struct IntegrationTestOptions 🔹 <a id="projen-awscdk-integrationtestoptions"></a>
+
+
+Options for `IntegrationTest`.
+
+
+
+Name | Type | Description 
+-----|------|-------------
+**entrypoint**🔹 | <code>string</code> | A path from the project root directory to a TypeScript file which contains the integration test app.
+**destroyAfterDeploy**?🔹 | <code>boolean</code> | Destroy the test app after a successful deployment.<br/>__*Default*__: true
 
 
 

package/docs/awscdk.md

@@ -95,37 +95,34 @@ new awscdk.LambdaFunction(p, {
 });
 ```
 
-## Integration Snapshot Tests (NOT IMPLEMENTED YET)
+## Integration Snapshot Tests
 
-Files in the test tree with the `.integ.ts` suffix are recognized as
+Files in the `test/` tree with the `.integ.ts` suffix are recognized as
 *integration snapshot tests*.
 
-Each test is a simple app (e.g. calls `app.synth()`) which exercises certain
+Each test is a simple CDK app (e.g. calls `app.synth()`) which exercises certain
 construct(s) within the project. A test is considered passing if the app can be
 successfully deployed.
 
-During build, integration test apps are synthesized and their output is compared
-to a committed *snapshot*. If the output is the same, the test has passed,
-otherwise the build will fail.
-
-To create/update the snapshot, developers need to manually execute the task
-`integ:NAME:deploy` with AWS credentials in their environment. This task will
-`cdk deploy` the test app to their development account and if deployment
-succeeded (i.e. the test passed), it will take a snapshot of the output and add
-it to the repository under a `xxx.integ.snapshot` directory. This directory
-should be committed to the repository.
-
-In addition to the `integ:NAME:deploy` task, for each integration test, the
-following set of tasks are created:
-
-* `integ:NAME:deploy` - deploys & destroys the test app and updates the snapshot.
-* `integ:NAME:destroy` - destroys a previously deployed test app.
-* `integ:NAME:assert` - synthesizes the test app and compares it with the
-  snapshot (this is the task that runs during build).
-* `integ:NAME:snapshot` - synthesizes the test app and updates the snapshot
-  (bypasses the deployment).
-* `integ:NAME:watch` - starts `cdk watch` for the test app (monitors all source
-  files and bundles).
+To create/update the snapshot, developers are expected to execute the task
+`integ:NAME:deploy` with AWS credentials for their personal development
+environment. This task will deploy the test app to their account. Upon
+successful deployment (i.e. the test passed), the snapshot will be captured and
+stored under a directory called `xxx.integ.snapshot` next to the test
+entrypoint. This directory should be committed to the repository.
+
+During builds (either local or within a workflow), the task `integ:NAME:assert`
+will be executed. This task synthesizes the test app and compares the output to
+the captured snapshot. The build will fail if the output differs.
+
+For each integration test, the following set of tasks are created:
+
+|Task|Description|
+|----|-----------|
+|`integ:NAME:deploy`|Deploys & destroys the test app and updates the snapshot.|
+|`integ:NAME:assert`|Synthesizes the test app and compares it with the snapshot (this is the task that runs during build)|
+|`integ:NAME:snapshot`|Synthesizes the test app and updates the snapshot (not recommended to use because it bypasses deployment).|
+|`integ:NAME:destroy`|Destroys a previously deployed test app.|
 
 ### Writing test assertions