Merge branch 'main' into use-terraform-cli-for-tfc

hashicorp · Jul 25, 2022 · daf70d7 · daf70d7
2 parents c60cdbd + cccfe3d
commit daf70d7
Show file tree

Hide file tree

Showing 137 changed files with 175,313 additions and 26,157 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ❓ Question
+    url: https://discuss.hashicorp.com/c/terraform-core/cdk-for-terraform/47
+    about: 🙋 For usage questions that may not require a core maintainer to answer, post in our community forum
+  - name: Terraform Cloud/Enterprise Troubleshooting
+    url: https://support.hashicorp.com/hc/en-us/requests/new
+    about: For issues related to the Terraform Cloud/Enterprise platform, please submit a HashiCorp support request or email tf-cloud@hashicorp.support
diff --git a/.prettierignore b/.prettierignore
@@ -11,3 +11,4 @@ packages/**/dist
 dist
 packages/@cdktf/provider-generator/edge-provider-bindings
 test/edge-provider-bindings
+!tools/documentation-generation/generate-documentation.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@
 
 Previously we would throw an error and exit with 1 if there were no provider or module specifications in the `cdktf.json` file. This can be inconvenient if `cdktf get` is part of a workflow.
 
+### `Fn.merge` is split into `Fn.mergeLists` and `Fn.mergeMaps`
+
+The Terraform `merge` function can merge both lists and maps, but this can cause [issues](https://github.com/hashicorp/terraform-cdk/issues/1653) when using the result in a typed language. Therefore we split it into `Fn.mergeLists` and `Fn.mergeMaps`, this means you need to change your cdktf programs code.
+
 ## 0.11.2
 
 ### feat

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -60,21 +60,53 @@ For development, you'd likely want to run:
 $ yarn watch
 ```
 
-This will watch for changes for the packages `cdktf` and `cdktf-cli`.
+This will watch for changes in all packages.
+
+### CLI changes
+
+If your changes target only CLI and packages used by the CLI, running `yarn watch` will be sufficient. Although it's technically a bit different from what we ship you should be able to use a direct path to our binary entry point to execute commands. You can put this in a shell alias like this:
+
+```shell
+alias cdktfl='/path/to/terraform-cdk/packages/cdktf-cli/bin/cdktf' # For running cdktf locally
+alias cdktfld='node --inspect-brk /path/to/terraform-cdk/packages/cdktf-cli/bin/cdktf.js' # For running cdktf locally with debugging
+
+$ cdktfl get
+```
+
+### Library changes
+
+If you make changes to the library you need to run `yarn build && yarn package` to run tests against the new version. You should be able to use the typescript examples by just running `yarn watch`.
 
 ## Tests
 
 If you just want to run the tests:
 
 ```shell
-$ yarn test
+$ yarn test # to run all tests at once
+$ yarn test:watch # to run all tests in watch mode
 ```
 
 To run integration tests, package and run integration tests.
 
 ```shell
 $ yarn package
-$ yarn integration
+$ yarn integration # For all integration tests
+$ yarn integration:single -- typescript/synth-app # For a single integration test
+```
+
+````
+
+If you need to update the snapshot tests, please run this for the unit tests:
+
+```shell
+$ yarn test:update
+````
+
+To update the integration tests, please run this:
+
+```shell
+$ yarn integration:update # For all integration tests
+$ yarn integration:single -- -u typescript/synth-app # For a single integration test
 ```
 
 ## Local Usage
@@ -207,7 +239,7 @@ reset the `FEATURE_FLAGS` map for the next cycle.
 
 ## Debugging
 
-We recommend enabling logging when you develop new features. To get detailed information about CDKTF operations, set `CDKTF_LOG_LEVEL` to `verbose`.
+We recommend enabling logging when you develop new features. To get detailed information about CDKTF operations, set `CDKTF_LOG_LEVEL` to `debug`.
 
 ## Releasing
 
@@ -314,3 +346,7 @@ Here are GitHub links that help this process:
 ## Reproducing Bugs on Windows
 
 A good way to tackle windows related things is to use an AWS EC2 instance running Windows. Here's a Terraform repo with a bit of guideline on how to connect via Remote Desktop or VS Code Remote SSH https://github.com/skorfmann/windows-test-machine
+
+## Documentation
+
+The markdown files containing the documentation for CDK for Terraform are in the [`/website`](./website) directory. Refer to the [website README](./website/README.md) for more information.
diff --git a/examples/typescript/aws-cloudfront-proxy/package.json b/examples/typescript/aws-cloudfront-proxy/package.json
@@ -21,10 +21,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/aws-kubernetes/package.json b/examples/typescript/aws-kubernetes/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/aws-multiple-stacks/package.json b/examples/typescript/aws-multiple-stacks/package.json
@@ -16,9 +16,9 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "typescript": "^3.9.10",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "cdktf-cli": "0.0.0"
   },
   "dependencies": {

diff --git a/examples/typescript/aws-prebuilt/package.json b/examples/typescript/aws-prebuilt/package.json
@@ -10,10 +10,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   },
   "dependencies": {

diff --git a/examples/typescript/azure-app-service/package.json b/examples/typescript/azure-app-service/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/azure-service-bus-queue-trigger/package.json b/examples/typescript/azure-service-bus-queue-trigger/package.json
@@ -20,16 +20,16 @@
     "node": ">=14.0"
   },
   "dependencies": {
-    "@cdktf/provider-azurerm": "^0.8.4",
+    "@cdktf/provider-azurerm": "^0.8.15",
     "cdktf": "^0.6.2",
     "constructs": "^10.0.25"
   },
   "devDependencies": {
     "@types/jest": "^27.5.2",
-    "@types/node": "^16.11.43",
+    "@types/node": "^16.11.45",
     "jest": "^27.5.1",
     "ts-jest": "^27.1.5",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/azure/package.json b/examples/typescript/azure/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/backends/azurerm/package.json b/examples/typescript/backends/azurerm/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/backends/gcs/package.json b/examples/typescript/backends/gcs/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/backends/remote/package.json b/examples/typescript/backends/remote/package.json
@@ -1,7 +1,5 @@
 {
-  "//": "This example test is disabled via the 'private' attribute since it needs credentials (I assume at least)",
   "name": "@examples/typescript-backends-remote",
-  "private": true,
   "version": "1.0.0",
   "main": "main.js",
   "types": "main.ts",
@@ -26,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/backends/s3/package.json b/examples/typescript/backends/s3/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/docker/package.json b/examples/typescript/docker/package.json
@@ -20,8 +20,8 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
-    "ts-node": "^10.8.2",
+    "@types/node": "^14.18.22",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10",
     "jest": "^27.5.1",
     "cdktf-cli": "0.0.0"

diff --git a/examples/typescript/google-cloudrun/package.json b/examples/typescript/google-cloudrun/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/google/package.json b/examples/typescript/google/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/kubernetes/package.json b/examples/typescript/kubernetes/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/provisioner/package.json b/examples/typescript/provisioner/package.json
@@ -19,9 +19,9 @@
     "constructs": "^10.0.25"
   },
   "devDependencies": {
-    "@types/jest": "27.4.1",
-    "@types/node": "^14.18.12",
-    "ts-node": "^10.7.0",
+    "@types/jest": "27.5.2",
+    "@types/node": "^14.18.22",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10",
     "jest": "^27.5.1",
     "cdktf-cli": "0.0.0"

diff --git a/examples/typescript/ucloud/package.json b/examples/typescript/ucloud/package.json
@@ -24,10 +24,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/examples/typescript/vault/package.json b/examples/typescript/vault/package.json
@@ -27,10 +27,10 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "^14.18.21",
+    "@types/node": "^14.18.22",
     "cdktf-cli": "0.0.0",
     "jest": "^27.5.1",
-    "ts-node": "^10.8.2",
+    "ts-node": "^10.9.1",
     "typescript": "^3.9.10"
   }
 }
diff --git a/lerna.json b/lerna.json
@@ -9,7 +9,8 @@
     "examples/java/*",
     "examples/csharp/*",
     "examples/go/*",
-    "test/*"
+    "test/*",
+    "tools/*"
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,

diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "link-packages": "lerna exec --scope 'cdktf*' --scope @cdktf/* yarn link",
     "integration": "cd test && yarn edge:install && ./run-against-dist npx jest --runInBand",
     "integration:update": "cd test && yarn && yarn edge:install && NODE_OPTIONS='--max-old-space-size=7168' ./run-against-dist npx jest -u --runInBand",
+    "integration:single": "cd test && ./run-against-dist npx jest --runInBand",
     "integration:typescript": "cd test && ./run-against-dist npx jest --runInBand typescript",
     "integration:python": "cd test && ./run-against-dist npx jest --runInBand python",
     "integration:csharp": "cd test && ./run-against-dist npx jest --runInBand csharp",
@@ -38,7 +39,8 @@
     "prepare": "husky install",
     "prepare-next-release": "standard-version --prerelease pre --release-as minor --skip.changelog=true --skip.commit=true",
     "prepare-release": "tools/prepare-release.sh",
-    "release": "standard-version"
+    "release": "standard-version",
+    "generate-docs": "cd tools/documentation-generation && yarn && yarn docs && npx prettier --write ../../website/docs/cdktf/api-reference/*.mdx"
   },
   "workspaces": {
     "packages": [
@@ -78,6 +80,7 @@
     "standard-version": "^9.5.0"
   },
   "lint-staged": {
+    "packages/cdktf": "yarn docs",
     "**/*.{ts,tsx,js,css,md}": "prettier --write"
   },
   "eslintConfig": {