@cdktn/provider-project 0.7.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +419 -0
- package/API.md +4154 -0
- package/CLAUDE.md +172 -0
- package/LICENSE +355 -0
- package/README.md +82 -0
- package/lib/alert-open-prs.d.ts +14 -0
- package/lib/alert-open-prs.js +67 -0
- package/lib/auto-approve.d.ts +11 -0
- package/lib/auto-approve.js +70 -0
- package/lib/auto-close-community-issues.d.ts +15 -0
- package/lib/auto-close-community-issues.js +104 -0
- package/lib/automerge.d.ts +11 -0
- package/lib/automerge.js +67 -0
- package/lib/cdktf-config.d.ts +33 -0
- package/lib/cdktf-config.js +134 -0
- package/lib/copyright-headers.d.ts +4 -0
- package/lib/copyright-headers.js +44 -0
- package/lib/customized-license.d.ts +8 -0
- package/lib/customized-license.js +19 -0
- package/lib/dependabot.d.ts +8 -0
- package/lib/dependabot.js +40 -0
- package/lib/deprecate-packages.d.ts +14 -0
- package/lib/deprecate-packages.js +91 -0
- package/lib/force-release.d.ts +12 -0
- package/lib/force-release.js +112 -0
- package/lib/github-issues.d.ts +15 -0
- package/lib/github-issues.js +33 -0
- package/lib/index.d.ts +53 -0
- package/lib/index.js +447 -0
- package/lib/lock-issues.d.ts +13 -0
- package/lib/lock-issues.js +54 -0
- package/lib/package-info.d.ts +14 -0
- package/lib/package-info.js +7 -0
- package/lib/provider-upgrade.d.ts +17 -0
- package/lib/provider-upgrade.js +145 -0
- package/lib/readme.d.ts +21 -0
- package/lib/readme.js +147 -0
- package/lib/scripts/check-for-upgrades.d.ts +15 -0
- package/lib/scripts/check-for-upgrades.js +186 -0
- package/lib/scripts/should-release.d.ts +13 -0
- package/lib/scripts/should-release.js +96 -0
- package/lib/util/random-cron.d.ts +18 -0
- package/lib/util/random-cron.js +33 -0
- package/mise.toml +2 -0
- package/node_modules/camel-case/LICENSE +21 -0
- package/node_modules/camel-case/README.md +47 -0
- package/node_modules/camel-case/dist/index.d.ts +5 -0
- package/node_modules/camel-case/dist/index.js +23 -0
- package/node_modules/camel-case/dist/index.js.map +1 -0
- package/node_modules/camel-case/dist/index.spec.d.ts +1 -0
- package/node_modules/camel-case/dist/index.spec.js +26 -0
- package/node_modules/camel-case/dist/index.spec.js.map +1 -0
- package/node_modules/camel-case/dist.es2015/index.d.ts +5 -0
- package/node_modules/camel-case/dist.es2015/index.js +17 -0
- package/node_modules/camel-case/dist.es2015/index.js.map +1 -0
- package/node_modules/camel-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/camel-case/dist.es2015/index.spec.js +24 -0
- package/node_modules/camel-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/camel-case/package.json +89 -0
- package/node_modules/capital-case/LICENSE +21 -0
- package/node_modules/capital-case/README.md +37 -0
- package/node_modules/capital-case/dist/index.d.ts +4 -0
- package/node_modules/capital-case/dist/index.js +16 -0
- package/node_modules/capital-case/dist/index.js.map +1 -0
- package/node_modules/capital-case/dist/index.spec.d.ts +1 -0
- package/node_modules/capital-case/dist/index.spec.js +24 -0
- package/node_modules/capital-case/dist/index.spec.js.map +1 -0
- package/node_modules/capital-case/dist.es2015/index.d.ts +4 -0
- package/node_modules/capital-case/dist.es2015/index.js +11 -0
- package/node_modules/capital-case/dist.es2015/index.js.map +1 -0
- package/node_modules/capital-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/capital-case/dist.es2015/index.spec.js +22 -0
- package/node_modules/capital-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/capital-case/package.json +90 -0
- package/node_modules/change-case/LICENSE +21 -0
- package/node_modules/change-case/README.md +44 -0
- package/node_modules/change-case/dist/index.d.ts +11 -0
- package/node_modules/change-case/dist/index.js +15 -0
- package/node_modules/change-case/dist/index.js.map +1 -0
- package/node_modules/change-case/dist/index.spec.d.ts +1 -0
- package/node_modules/change-case/dist/index.spec.js +9 -0
- package/node_modules/change-case/dist/index.spec.js.map +1 -0
- package/node_modules/change-case/dist.es2015/index.d.ts +11 -0
- package/node_modules/change-case/dist.es2015/index.js +12 -0
- package/node_modules/change-case/dist.es2015/index.js.map +1 -0
- package/node_modules/change-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/change-case/dist.es2015/index.spec.js +7 -0
- package/node_modules/change-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/change-case/package.json +101 -0
- package/node_modules/constant-case/LICENSE +21 -0
- package/node_modules/constant-case/README.md +37 -0
- package/node_modules/constant-case/dist/index.d.ts +3 -0
- package/node_modules/constant-case/dist/index.js +12 -0
- package/node_modules/constant-case/dist/index.js.map +1 -0
- package/node_modules/constant-case/dist/index.spec.d.ts +1 -0
- package/node_modules/constant-case/dist/index.spec.js +26 -0
- package/node_modules/constant-case/dist/index.spec.js.map +1 -0
- package/node_modules/constant-case/dist.es2015/index.d.ts +3 -0
- package/node_modules/constant-case/dist.es2015/index.js +8 -0
- package/node_modules/constant-case/dist.es2015/index.js.map +1 -0
- package/node_modules/constant-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/constant-case/dist.es2015/index.spec.js +24 -0
- package/node_modules/constant-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/constant-case/package.json +90 -0
- package/node_modules/dot-case/LICENSE +21 -0
- package/node_modules/dot-case/README.md +37 -0
- package/node_modules/dot-case/dist/index.d.ts +3 -0
- package/node_modules/dot-case/dist/index.js +11 -0
- package/node_modules/dot-case/dist/index.js.map +1 -0
- package/node_modules/dot-case/dist/index.spec.d.ts +1 -0
- package/node_modules/dot-case/dist/index.spec.js +26 -0
- package/node_modules/dot-case/dist/index.spec.js.map +1 -0
- package/node_modules/dot-case/dist.es2015/index.d.ts +3 -0
- package/node_modules/dot-case/dist.es2015/index.js +7 -0
- package/node_modules/dot-case/dist.es2015/index.js.map +1 -0
- package/node_modules/dot-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/dot-case/dist.es2015/index.spec.js +24 -0
- package/node_modules/dot-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/dot-case/package.json +89 -0
- package/node_modules/fs-extra/LICENSE +15 -0
- package/node_modules/fs-extra/README.md +262 -0
- package/node_modules/fs-extra/lib/copy/copy-sync.js +169 -0
- package/node_modules/fs-extra/lib/copy/copy.js +235 -0
- package/node_modules/fs-extra/lib/copy/index.js +7 -0
- package/node_modules/fs-extra/lib/empty/index.js +39 -0
- package/node_modules/fs-extra/lib/ensure/file.js +69 -0
- package/node_modules/fs-extra/lib/ensure/index.js +23 -0
- package/node_modules/fs-extra/lib/ensure/link.js +64 -0
- package/node_modules/fs-extra/lib/ensure/symlink-paths.js +99 -0
- package/node_modules/fs-extra/lib/ensure/symlink-type.js +31 -0
- package/node_modules/fs-extra/lib/ensure/symlink.js +82 -0
- package/node_modules/fs-extra/lib/fs/index.js +128 -0
- package/node_modules/fs-extra/lib/index.js +16 -0
- package/node_modules/fs-extra/lib/json/index.js +16 -0
- package/node_modules/fs-extra/lib/json/jsonfile.js +11 -0
- package/node_modules/fs-extra/lib/json/output-json-sync.js +12 -0
- package/node_modules/fs-extra/lib/json/output-json.js +12 -0
- package/node_modules/fs-extra/lib/mkdirs/index.js +14 -0
- package/node_modules/fs-extra/lib/mkdirs/make-dir.js +27 -0
- package/node_modules/fs-extra/lib/mkdirs/utils.js +21 -0
- package/node_modules/fs-extra/lib/move/index.js +7 -0
- package/node_modules/fs-extra/lib/move/move-sync.js +54 -0
- package/node_modules/fs-extra/lib/move/move.js +75 -0
- package/node_modules/fs-extra/lib/output-file/index.js +40 -0
- package/node_modules/fs-extra/lib/path-exists/index.js +12 -0
- package/node_modules/fs-extra/lib/remove/index.js +22 -0
- package/node_modules/fs-extra/lib/remove/rimraf.js +302 -0
- package/node_modules/fs-extra/lib/util/stat.js +154 -0
- package/node_modules/fs-extra/lib/util/utimes.js +26 -0
- package/node_modules/fs-extra/package.json +67 -0
- package/node_modules/graceful-fs/LICENSE +15 -0
- package/node_modules/graceful-fs/README.md +143 -0
- package/node_modules/graceful-fs/clone.js +23 -0
- package/node_modules/graceful-fs/graceful-fs.js +448 -0
- package/node_modules/graceful-fs/legacy-streams.js +118 -0
- package/node_modules/graceful-fs/package.json +53 -0
- package/node_modules/graceful-fs/polyfills.js +355 -0
- package/node_modules/header-case/LICENSE +21 -0
- package/node_modules/header-case/README.md +37 -0
- package/node_modules/header-case/dist/index.d.ts +3 -0
- package/node_modules/header-case/dist/index.js +11 -0
- package/node_modules/header-case/dist/index.js.map +1 -0
- package/node_modules/header-case/dist/index.spec.d.ts +1 -0
- package/node_modules/header-case/dist/index.spec.js +24 -0
- package/node_modules/header-case/dist/index.spec.js.map +1 -0
- package/node_modules/header-case/dist.es2015/index.d.ts +3 -0
- package/node_modules/header-case/dist.es2015/index.js +7 -0
- package/node_modules/header-case/dist.es2015/index.js.map +1 -0
- package/node_modules/header-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/header-case/dist.es2015/index.spec.js +22 -0
- package/node_modules/header-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/header-case/package.json +89 -0
- package/node_modules/jsonfile/LICENSE +15 -0
- package/node_modules/jsonfile/README.md +230 -0
- package/node_modules/jsonfile/index.js +88 -0
- package/node_modules/jsonfile/package.json +40 -0
- package/node_modules/jsonfile/utils.js +14 -0
- package/node_modules/lower-case/LICENSE +21 -0
- package/node_modules/lower-case/README.md +35 -0
- package/node_modules/lower-case/dist/index.d.ts +8 -0
- package/node_modules/lower-case/dist/index.js +53 -0
- package/node_modules/lower-case/dist/index.js.map +1 -0
- package/node_modules/lower-case/dist/index.spec.d.ts +1 -0
- package/node_modules/lower-case/dist/index.spec.js +36 -0
- package/node_modules/lower-case/dist/index.spec.js.map +1 -0
- package/node_modules/lower-case/dist.es2015/index.d.ts +8 -0
- package/node_modules/lower-case/dist.es2015/index.js +48 -0
- package/node_modules/lower-case/dist.es2015/index.js.map +1 -0
- package/node_modules/lower-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/lower-case/dist.es2015/index.spec.js +34 -0
- package/node_modules/lower-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/lower-case/package.json +87 -0
- package/node_modules/no-case/LICENSE +21 -0
- package/node_modules/no-case/README.md +37 -0
- package/node_modules/no-case/dist/index.d.ts +10 -0
- package/node_modules/no-case/dist/index.js +35 -0
- package/node_modules/no-case/dist/index.js.map +1 -0
- package/node_modules/no-case/dist/index.spec.d.ts +1 -0
- package/node_modules/no-case/dist/index.spec.js +59 -0
- package/node_modules/no-case/dist/index.spec.js.map +1 -0
- package/node_modules/no-case/dist.es2015/index.d.ts +10 -0
- package/node_modules/no-case/dist.es2015/index.js +31 -0
- package/node_modules/no-case/dist.es2015/index.js.map +1 -0
- package/node_modules/no-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/no-case/dist.es2015/index.spec.js +57 -0
- package/node_modules/no-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/no-case/package.json +85 -0
- package/node_modules/param-case/LICENSE +21 -0
- package/node_modules/param-case/README.md +37 -0
- package/node_modules/param-case/dist/index.d.ts +3 -0
- package/node_modules/param-case/dist/index.js +11 -0
- package/node_modules/param-case/dist/index.js.map +1 -0
- package/node_modules/param-case/dist/index.spec.d.ts +1 -0
- package/node_modules/param-case/dist/index.spec.js +24 -0
- package/node_modules/param-case/dist/index.spec.js.map +1 -0
- package/node_modules/param-case/dist.es2015/index.d.ts +3 -0
- package/node_modules/param-case/dist.es2015/index.js +7 -0
- package/node_modules/param-case/dist.es2015/index.js.map +1 -0
- package/node_modules/param-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/param-case/dist.es2015/index.spec.js +22 -0
- package/node_modules/param-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/param-case/package.json +91 -0
- package/node_modules/pascal-case/LICENSE +21 -0
- package/node_modules/pascal-case/README.md +47 -0
- package/node_modules/pascal-case/dist/index.d.ts +5 -0
- package/node_modules/pascal-case/dist/index.js +24 -0
- package/node_modules/pascal-case/dist/index.js.map +1 -0
- package/node_modules/pascal-case/dist/index.spec.d.ts +1 -0
- package/node_modules/pascal-case/dist/index.spec.js +25 -0
- package/node_modules/pascal-case/dist/index.spec.js.map +1 -0
- package/node_modules/pascal-case/dist.es2015/index.d.ts +5 -0
- package/node_modules/pascal-case/dist.es2015/index.js +18 -0
- package/node_modules/pascal-case/dist.es2015/index.js.map +1 -0
- package/node_modules/pascal-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/pascal-case/dist.es2015/index.spec.js +23 -0
- package/node_modules/pascal-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/pascal-case/package.json +90 -0
- package/node_modules/path-case/LICENSE +21 -0
- package/node_modules/path-case/README.md +37 -0
- package/node_modules/path-case/dist/index.d.ts +3 -0
- package/node_modules/path-case/dist/index.js +11 -0
- package/node_modules/path-case/dist/index.js.map +1 -0
- package/node_modules/path-case/dist/index.spec.d.ts +1 -0
- package/node_modules/path-case/dist/index.spec.js +24 -0
- package/node_modules/path-case/dist/index.spec.js.map +1 -0
- package/node_modules/path-case/dist.es2015/index.d.ts +3 -0
- package/node_modules/path-case/dist.es2015/index.js +7 -0
- package/node_modules/path-case/dist.es2015/index.js.map +1 -0
- package/node_modules/path-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/path-case/dist.es2015/index.spec.js +22 -0
- package/node_modules/path-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/path-case/package.json +88 -0
- package/node_modules/sentence-case/LICENSE +21 -0
- package/node_modules/sentence-case/README.md +37 -0
- package/node_modules/sentence-case/dist/index.d.ts +4 -0
- package/node_modules/sentence-case/dist/index.js +19 -0
- package/node_modules/sentence-case/dist/index.js.map +1 -0
- package/node_modules/sentence-case/dist/index.spec.d.ts +1 -0
- package/node_modules/sentence-case/dist/index.spec.js +24 -0
- package/node_modules/sentence-case/dist/index.spec.js.map +1 -0
- package/node_modules/sentence-case/dist.es2015/index.d.ts +4 -0
- package/node_modules/sentence-case/dist.es2015/index.js +14 -0
- package/node_modules/sentence-case/dist.es2015/index.js.map +1 -0
- package/node_modules/sentence-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/sentence-case/dist.es2015/index.spec.js +22 -0
- package/node_modules/sentence-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/sentence-case/package.json +89 -0
- package/node_modules/snake-case/LICENSE +21 -0
- package/node_modules/snake-case/README.md +37 -0
- package/node_modules/snake-case/dist/index.d.ts +3 -0
- package/node_modules/snake-case/dist/index.js +11 -0
- package/node_modules/snake-case/dist/index.js.map +1 -0
- package/node_modules/snake-case/dist/index.spec.d.ts +1 -0
- package/node_modules/snake-case/dist/index.spec.js +25 -0
- package/node_modules/snake-case/dist/index.spec.js.map +1 -0
- package/node_modules/snake-case/dist.es2015/index.d.ts +3 -0
- package/node_modules/snake-case/dist.es2015/index.js +7 -0
- package/node_modules/snake-case/dist.es2015/index.js.map +1 -0
- package/node_modules/snake-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/snake-case/dist.es2015/index.spec.js +23 -0
- package/node_modules/snake-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/snake-case/package.json +90 -0
- package/node_modules/tslib/CopyrightNotice.txt +15 -0
- package/node_modules/tslib/LICENSE.txt +12 -0
- package/node_modules/tslib/README.md +164 -0
- package/node_modules/tslib/SECURITY.md +41 -0
- package/node_modules/tslib/modules/index.d.ts +38 -0
- package/node_modules/tslib/modules/index.js +70 -0
- package/node_modules/tslib/modules/package.json +3 -0
- package/node_modules/tslib/package.json +47 -0
- package/node_modules/tslib/tslib.d.ts +460 -0
- package/node_modules/tslib/tslib.es6.html +1 -0
- package/node_modules/tslib/tslib.es6.js +402 -0
- package/node_modules/tslib/tslib.es6.mjs +401 -0
- package/node_modules/tslib/tslib.html +1 -0
- package/node_modules/tslib/tslib.js +484 -0
- package/node_modules/universalify/LICENSE +20 -0
- package/node_modules/universalify/README.md +76 -0
- package/node_modules/universalify/index.js +24 -0
- package/node_modules/universalify/package.json +34 -0
- package/node_modules/upper-case/README.md +34 -0
- package/node_modules/upper-case/dist/index.d.ts +8 -0
- package/node_modules/upper-case/dist/index.js +49 -0
- package/node_modules/upper-case/dist/index.js.map +1 -0
- package/node_modules/upper-case/dist/index.spec.d.ts +1 -0
- package/node_modules/upper-case/dist/index.spec.js +34 -0
- package/node_modules/upper-case/dist/index.spec.js.map +1 -0
- package/node_modules/upper-case/dist.es2015/index.d.ts +8 -0
- package/node_modules/upper-case/dist.es2015/index.js +44 -0
- package/node_modules/upper-case/dist.es2015/index.js.map +1 -0
- package/node_modules/upper-case/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/upper-case/dist.es2015/index.spec.js +32 -0
- package/node_modules/upper-case/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/upper-case/package.json +86 -0
- package/node_modules/upper-case-first/LICENSE +21 -0
- package/node_modules/upper-case-first/README.md +32 -0
- package/node_modules/upper-case-first/dist/index.d.ts +4 -0
- package/node_modules/upper-case-first/dist/index.js +11 -0
- package/node_modules/upper-case-first/dist/index.js.map +1 -0
- package/node_modules/upper-case-first/dist/index.spec.d.ts +1 -0
- package/node_modules/upper-case-first/dist/index.spec.js +20 -0
- package/node_modules/upper-case-first/dist/index.spec.js.map +1 -0
- package/node_modules/upper-case-first/dist.es2015/index.d.ts +4 -0
- package/node_modules/upper-case-first/dist.es2015/index.js +7 -0
- package/node_modules/upper-case-first/dist.es2015/index.js.map +1 -0
- package/node_modules/upper-case-first/dist.es2015/index.spec.d.ts +1 -0
- package/node_modules/upper-case-first/dist.es2015/index.spec.js +18 -0
- package/node_modules/upper-case-first/dist.es2015/index.spec.js.map +1 -0
- package/node_modules/upper-case-first/package.json +87 -0
- package/package.json +181 -0
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
4
|
+
|
|
5
|
+
## Project Overview
|
|
6
|
+
|
|
7
|
+
This is a Projen (https://projen.io) project template for creating CDKTF (CDK for Terraform) pre-built provider binding repositories. This is a fork maintained by CDK Terrain (cdktn.io) after HashiCorp's sunset announcement on December 10, 2025.
|
|
8
|
+
|
|
9
|
+
**Purpose**: This repository generates the structure and workflows for individual provider repositories. Changes made here propagate to all downstream provider repos (managed at cdktn-io/repository-manager).
|
|
10
|
+
|
|
11
|
+
## Key Concepts
|
|
12
|
+
|
|
13
|
+
- **Provider Projects**: This template is used to bootstrap provider repos (e.g., `cdktn-provider-aws`, `cdktn-provider-google`) that contain pre-built TypeScript, Python, Java, C#, and Go bindings for Terraform providers
|
|
14
|
+
- **Projen-based**: Everything is code-generated from `.projenrc.ts` - never manually edit generated files
|
|
15
|
+
- **Downstream Impact**: Changes here affect hundreds of provider repositories when they upgrade to newer versions of `@cdktn/provider-project`
|
|
16
|
+
|
|
17
|
+
## Common Commands
|
|
18
|
+
|
|
19
|
+
### Development
|
|
20
|
+
```bash
|
|
21
|
+
npx projen # Regenerate all project files from .projenrc.ts
|
|
22
|
+
npm run build # Compile TypeScript and run all build steps
|
|
23
|
+
npm run compile # Compile TypeScript only
|
|
24
|
+
npm test # Run Jest tests
|
|
25
|
+
npm run eslint # Lint TypeScript files
|
|
26
|
+
npm run eslint:fix # Fix auto-fixable linting issues
|
|
27
|
+
npm run validate-workflows # Validate GitHub Actions workflow YAML files
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Testing Changes
|
|
31
|
+
```bash
|
|
32
|
+
yarn link # Create a local link for testing in provider repos
|
|
33
|
+
# In a provider repo:
|
|
34
|
+
yarn link @cdktn/provider-project
|
|
35
|
+
npx projen # Apply the linked version
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Architecture
|
|
39
|
+
|
|
40
|
+
### Core Components
|
|
41
|
+
|
|
42
|
+
**`src/index.ts` - CdktnProviderProject Class**
|
|
43
|
+
The main export. Creates a Jsii project with:
|
|
44
|
+
- Multi-language package publishing (npm, PyPI, Maven, NuGet, Go)
|
|
45
|
+
- GitHub Actions workflows for build, release, and provider upgrades
|
|
46
|
+
- Automated dependency management and version bumping
|
|
47
|
+
- Provider-specific configuration (namespace, version constraints)
|
|
48
|
+
- Custom runners for memory-intensive builds (configurable via `useCustomGithubRunner`)
|
|
49
|
+
|
|
50
|
+
**Configuration Files Generated for Provider Repos:**
|
|
51
|
+
|
|
52
|
+
**NOTE**: For Legacy support these MUST not be renamed
|
|
53
|
+
|
|
54
|
+
- `cdktf.json` - Tells `cdktf get` which provider to fetch
|
|
55
|
+
- `src/version.json` - Tracks the actual provider version after fetch
|
|
56
|
+
- Custom GitHub workflows for provider upgrades, auto-merge, and releases
|
|
57
|
+
|
|
58
|
+
### Component Modules
|
|
59
|
+
|
|
60
|
+
Each file in `src/` adds specific functionality to generated provider projects:
|
|
61
|
+
|
|
62
|
+
- **`cdktf-config.ts`**: Sets up CDKTF dependencies, creates fetch task (`cdktf get`), configures build scripts
|
|
63
|
+
- **`provider-upgrade.ts`**: Daily cron workflow that checks for new provider versions and creates auto-merge PRs
|
|
64
|
+
- **`readme.ts`**: Generates comprehensive README with package installation instructions for all languages
|
|
65
|
+
- **`auto-approve.ts` / `automerge.ts`**: GitHub workflows for automated PR approval/merging
|
|
66
|
+
- **`copyright-headers.ts`**: Adds HashiCorp copyright headers using the `copywrite` tool
|
|
67
|
+
- **`deprecate-packages.ts`**: Handles deprecation notices when `isDeprecated: true`
|
|
68
|
+
- **`lock-issues.ts`**: Auto-locks resolved issues after 90 days
|
|
69
|
+
- **`github-issues.ts`**: Issue templates and bot configurations
|
|
70
|
+
|
|
71
|
+
### Scripts (Generated for Provider Repos)
|
|
72
|
+
|
|
73
|
+
**`src/scripts/check-for-upgrades.ts`**
|
|
74
|
+
Compares current provider version against Terraform Registry to detect new releases.
|
|
75
|
+
|
|
76
|
+
**`src/scripts/should-release.ts`**
|
|
77
|
+
Determines if a release is needed by comparing `version.json` against the last git tag.
|
|
78
|
+
|
|
79
|
+
### Key Workflow Patterns
|
|
80
|
+
|
|
81
|
+
**Provider Update Flow:**
|
|
82
|
+
1. `provider-upgrade` workflow runs daily (randomized cron between 3-4am)
|
|
83
|
+
2. Checks Terraform Registry for new provider version
|
|
84
|
+
3. If available, runs `yarn fetch` (which executes `cdktf get`)
|
|
85
|
+
4. Adds copyright headers back (they get nuked by fetch)
|
|
86
|
+
5. Creates PR with appropriate semantic commit message (`feat:` for minor, `fix:` for patch)
|
|
87
|
+
6. Auto-approve and auto-merge labels trigger automated merge
|
|
88
|
+
|
|
89
|
+
**Release Flow:**
|
|
90
|
+
1. Build workflow runs on every push
|
|
91
|
+
2. `should-release.js` compares `src/version.json` against git tags
|
|
92
|
+
3. If changes detected, release workflow publishes to all package registries
|
|
93
|
+
4. Custom `unconditional-bump` task sets version in package.json for Go docs
|
|
94
|
+
|
|
95
|
+
**Memory Management:**
|
|
96
|
+
- Default GitHub runners: 7GB (heap limit ~6.6GB)
|
|
97
|
+
- Custom runners: 32GB (heap limit ~31.7GB)
|
|
98
|
+
- Set via `NODE_OPTIONS` environment variable: `--max-old-space-size`
|
|
99
|
+
|
|
100
|
+
## Important Configuration Details
|
|
101
|
+
|
|
102
|
+
### GitHub Actions Pinning
|
|
103
|
+
All GitHub Actions use pinned commit SHAs (not version tags) for security. Update both:
|
|
104
|
+
1. `.projenrc.ts` (this repo)
|
|
105
|
+
2. `src/index.ts` (for generated provider repos)
|
|
106
|
+
|
|
107
|
+
### JSII and TypeScript Versions
|
|
108
|
+
**CRITICAL**: JSII and TypeScript must use the same major/minor version range.
|
|
109
|
+
- Example: `jsiiVersion: "~5.8.0"` requires `typescriptVersion: "~5.8.0"`
|
|
110
|
+
- This constraint exists in both `.projenrc.ts` and provider project options
|
|
111
|
+
|
|
112
|
+
### Package Naming Convention
|
|
113
|
+
Generated packages follow this pattern:
|
|
114
|
+
- **npm**: `@{namespace}/provider-{providerName}`
|
|
115
|
+
- **Python**: `{namespace}-provider-{providerName}`
|
|
116
|
+
- **Go**: `github.com/{githubNamespace}/cdktn-provider-{providerName}-go`
|
|
117
|
+
|
|
118
|
+
### For Future
|
|
119
|
+
|
|
120
|
+
- **Maven**: `{mavenOrg}.providers.{providerName}`
|
|
121
|
+
- **NuGet**: `{NuGetOrg}.Providers.{ProviderName}`
|
|
122
|
+
|
|
123
|
+
Special cases: `null` and `random` providers get `_provider` suffix in Maven to avoid keyword conflicts.
|
|
124
|
+
|
|
125
|
+
## Deprecation Workflow
|
|
126
|
+
|
|
127
|
+
When `isDeprecated: true`:
|
|
128
|
+
- Disables dependency upgrades
|
|
129
|
+
- Skips provider upgrade workflow
|
|
130
|
+
- Adds deprecation notice to README
|
|
131
|
+
- Release workflow includes deprecation step for package managers
|
|
132
|
+
- Go packages get deprecation comment in generated code
|
|
133
|
+
|
|
134
|
+
## Testing Strategy
|
|
135
|
+
|
|
136
|
+
Tests use snapshot testing via `synthSnapshot()` helper:
|
|
137
|
+
- Generates a full Projen project in memory
|
|
138
|
+
- Captures all generated files
|
|
139
|
+
- Compares against committed snapshots
|
|
140
|
+
- Update snapshots: `npm test -- -u`
|
|
141
|
+
|
|
142
|
+
Key test scenarios:
|
|
143
|
+
- Minimal configuration
|
|
144
|
+
- Custom GitHub runners
|
|
145
|
+
- Deprecated providers
|
|
146
|
+
- Various version range syntaxes
|
|
147
|
+
- Maven/NuGet org overrides
|
|
148
|
+
|
|
149
|
+
## Making Changes
|
|
150
|
+
|
|
151
|
+
1. **Modify `.projenrc.ts` or `src/` files** - Never edit generated files directly
|
|
152
|
+
2. **Run `npx projen`** - Regenerates all project files
|
|
153
|
+
3. **Run tests** - `npm test`
|
|
154
|
+
4. **Validate workflows** - Happens automatically in post-compile, checks YAML against schemas
|
|
155
|
+
5. **Test in a provider repo** - Use `yarn link` for local testing
|
|
156
|
+
6. **Commit and release** - Auto-release on main branch (if not paths-ignored)
|
|
157
|
+
|
|
158
|
+
## Fork-Specific Context
|
|
159
|
+
|
|
160
|
+
This fork (cdktn.io) continues development after HashiCorp's sunset. With a Phased approach.
|
|
161
|
+
- Uses `cdktf` and `cdktf-cli` packages instead of `cdktf` until the core project rename has completed, the priority is to restart the provider binding generation first.
|
|
162
|
+
- In the near future, will Use `cdktn` and `cdktn-cli` packages instead of `cdktf`
|
|
163
|
+
- Default `githubNamespace` updated to "cdktn-io" due to Hashicorp maintaining copyright over original cdtkf/cdk.tf/terraform-cdk orgs, repositories and package names.
|
|
164
|
+
- Maintain support custom namespaces for organizations wanting to publish their own provider bindings
|
|
165
|
+
|
|
166
|
+
## Common Gotchas
|
|
167
|
+
|
|
168
|
+
- **Don't manually edit workflow YAML files** - Modify the Projen components in `src/` instead
|
|
169
|
+
- **Provider repos need secrets** - NPM_TOKEN, TWINE_*, MAVEN_*, GH_TOKEN for publishing (this is managed by a separate project called the "cdkn-repository-manager")
|
|
170
|
+
- **Fetch nukes src/ directory** - Copyright headers must be re-added after `cdktf get`
|
|
171
|
+
- **version.json has exactly one entry** - Multi-provider projects are not supported
|
|
172
|
+
- **Release task is conditional** - Controlled by `should-release.js`, use `unconditional-release` to force
|
package/LICENSE
ADDED
|
@@ -0,0 +1,355 @@
|
|
|
1
|
+
Copyright (c) 2020 HashiCorp, Inc.
|
|
2
|
+
|
|
3
|
+
Mozilla Public License, version 2.0
|
|
4
|
+
|
|
5
|
+
1. Definitions
|
|
6
|
+
|
|
7
|
+
1.1. “Contributor”
|
|
8
|
+
|
|
9
|
+
means each individual or legal entity that creates, contributes to the
|
|
10
|
+
creation of, or owns Covered Software.
|
|
11
|
+
|
|
12
|
+
1.2. “Contributor Version”
|
|
13
|
+
|
|
14
|
+
means the combination of the Contributions of others (if any) used by a
|
|
15
|
+
Contributor and that particular Contributor’s Contribution.
|
|
16
|
+
|
|
17
|
+
1.3. “Contribution”
|
|
18
|
+
|
|
19
|
+
means Covered Software of a particular Contributor.
|
|
20
|
+
|
|
21
|
+
1.4. “Covered Software”
|
|
22
|
+
|
|
23
|
+
means Source Code Form to which the initial Contributor has attached the
|
|
24
|
+
notice in Exhibit A, the Executable Form of such Source Code Form, and
|
|
25
|
+
Modifications of such Source Code Form, in each case including portions
|
|
26
|
+
thereof.
|
|
27
|
+
|
|
28
|
+
1.5. “Incompatible With Secondary Licenses”
|
|
29
|
+
means
|
|
30
|
+
|
|
31
|
+
a. that the initial Contributor has attached the notice described in
|
|
32
|
+
Exhibit B to the Covered Software; or
|
|
33
|
+
|
|
34
|
+
b. that the Covered Software was made available under the terms of version
|
|
35
|
+
1.1 or earlier of the License, but not also under the terms of a
|
|
36
|
+
Secondary License.
|
|
37
|
+
|
|
38
|
+
1.6. “Executable Form”
|
|
39
|
+
|
|
40
|
+
means any form of the work other than Source Code Form.
|
|
41
|
+
|
|
42
|
+
1.7. “Larger Work”
|
|
43
|
+
|
|
44
|
+
means a work that combines Covered Software with other material, in a separate
|
|
45
|
+
file or files, that is not Covered Software.
|
|
46
|
+
|
|
47
|
+
1.8. “License”
|
|
48
|
+
|
|
49
|
+
means this document.
|
|
50
|
+
|
|
51
|
+
1.9. “Licensable”
|
|
52
|
+
|
|
53
|
+
means having the right to grant, to the maximum extent possible, whether at the
|
|
54
|
+
time of the initial grant or subsequently, any and all of the rights conveyed by
|
|
55
|
+
this License.
|
|
56
|
+
|
|
57
|
+
1.10. “Modifications”
|
|
58
|
+
|
|
59
|
+
means any of the following:
|
|
60
|
+
|
|
61
|
+
a. any file in Source Code Form that results from an addition to, deletion
|
|
62
|
+
from, or modification of the contents of Covered Software; or
|
|
63
|
+
|
|
64
|
+
b. any new file in Source Code Form that contains any Covered Software.
|
|
65
|
+
|
|
66
|
+
1.11. “Patent Claims” of a Contributor
|
|
67
|
+
|
|
68
|
+
means any patent claim(s), including without limitation, method, process,
|
|
69
|
+
and apparatus claims, in any patent Licensable by such Contributor that
|
|
70
|
+
would be infringed, but for the grant of the License, by the making,
|
|
71
|
+
using, selling, offering for sale, having made, import, or transfer of
|
|
72
|
+
either its Contributions or its Contributor Version.
|
|
73
|
+
|
|
74
|
+
1.12. “Secondary License”
|
|
75
|
+
|
|
76
|
+
means either the GNU General Public License, Version 2.0, the GNU Lesser
|
|
77
|
+
General Public License, Version 2.1, the GNU Affero General Public
|
|
78
|
+
License, Version 3.0, or any later versions of those licenses.
|
|
79
|
+
|
|
80
|
+
1.13. “Source Code Form”
|
|
81
|
+
|
|
82
|
+
means the form of the work preferred for making modifications.
|
|
83
|
+
|
|
84
|
+
1.14. “You” (or “Your”)
|
|
85
|
+
|
|
86
|
+
means an individual or a legal entity exercising rights under this
|
|
87
|
+
License. For legal entities, “You” includes any entity that controls, is
|
|
88
|
+
controlled by, or is under common control with You. For purposes of this
|
|
89
|
+
definition, “control” means (a) the power, direct or indirect, to cause
|
|
90
|
+
the direction or management of such entity, whether by contract or
|
|
91
|
+
otherwise, or (b) ownership of more than fifty percent (50%) of the
|
|
92
|
+
outstanding shares or beneficial ownership of such entity.
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
2. License Grants and Conditions
|
|
96
|
+
|
|
97
|
+
2.1. Grants
|
|
98
|
+
|
|
99
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
100
|
+
non-exclusive license:
|
|
101
|
+
|
|
102
|
+
a. under intellectual property rights (other than patent or trademark)
|
|
103
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
104
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
105
|
+
Contributions, either on an unmodified basis, with Modifications, or as
|
|
106
|
+
part of a Larger Work; and
|
|
107
|
+
|
|
108
|
+
b. under Patent Claims of such Contributor to make, use, sell, offer for
|
|
109
|
+
sale, have made, import, and otherwise transfer either its Contributions
|
|
110
|
+
or its Contributor Version.
|
|
111
|
+
|
|
112
|
+
2.2. Effective Date
|
|
113
|
+
|
|
114
|
+
The licenses granted in Section 2.1 with respect to any Contribution become
|
|
115
|
+
effective for each Contribution on the date the Contributor first distributes
|
|
116
|
+
such Contribution.
|
|
117
|
+
|
|
118
|
+
2.3. Limitations on Grant Scope
|
|
119
|
+
|
|
120
|
+
The licenses granted in this Section 2 are the only rights granted under this
|
|
121
|
+
License. No additional rights or licenses will be implied from the distribution
|
|
122
|
+
or licensing of Covered Software under this License. Notwithstanding Section
|
|
123
|
+
2.1(b) above, no patent license is granted by a Contributor:
|
|
124
|
+
|
|
125
|
+
a. for any code that a Contributor has removed from Covered Software; or
|
|
126
|
+
|
|
127
|
+
b. for infringements caused by: (i) Your and any other third party’s
|
|
128
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
129
|
+
Contributions with other software (except as part of its Contributor
|
|
130
|
+
Version); or
|
|
131
|
+
|
|
132
|
+
c. under Patent Claims infringed by Covered Software in the absence of its
|
|
133
|
+
Contributions.
|
|
134
|
+
|
|
135
|
+
This License does not grant any rights in the trademarks, service marks, or
|
|
136
|
+
logos of any Contributor (except as may be necessary to comply with the
|
|
137
|
+
notice requirements in Section 3.4).
|
|
138
|
+
|
|
139
|
+
2.4. Subsequent Licenses
|
|
140
|
+
|
|
141
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
142
|
+
distribute the Covered Software under a subsequent version of this License
|
|
143
|
+
(see Section 10.2) or under the terms of a Secondary License (if permitted
|
|
144
|
+
under the terms of Section 3.3).
|
|
145
|
+
|
|
146
|
+
2.5. Representation
|
|
147
|
+
|
|
148
|
+
Each Contributor represents that the Contributor believes its Contributions
|
|
149
|
+
are its original creation(s) or it has sufficient rights to grant the
|
|
150
|
+
rights to its Contributions conveyed by this License.
|
|
151
|
+
|
|
152
|
+
2.6. Fair Use
|
|
153
|
+
|
|
154
|
+
This License is not intended to limit any rights You have under applicable
|
|
155
|
+
copyright doctrines of fair use, fair dealing, or other equivalents.
|
|
156
|
+
|
|
157
|
+
2.7. Conditions
|
|
158
|
+
|
|
159
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
|
|
160
|
+
Section 2.1.
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
3. Responsibilities
|
|
164
|
+
|
|
165
|
+
3.1. Distribution of Source Form
|
|
166
|
+
|
|
167
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
168
|
+
Modifications that You create or to which You contribute, must be under the
|
|
169
|
+
terms of this License. You must inform recipients that the Source Code Form
|
|
170
|
+
of the Covered Software is governed by the terms of this License, and how
|
|
171
|
+
they can obtain a copy of this License. You may not attempt to alter or
|
|
172
|
+
restrict the recipients’ rights in the Source Code Form.
|
|
173
|
+
|
|
174
|
+
3.2. Distribution of Executable Form
|
|
175
|
+
|
|
176
|
+
If You distribute Covered Software in Executable Form then:
|
|
177
|
+
|
|
178
|
+
a. such Covered Software must also be made available in Source Code Form,
|
|
179
|
+
as described in Section 3.1, and You must inform recipients of the
|
|
180
|
+
Executable Form how they can obtain a copy of such Source Code Form by
|
|
181
|
+
reasonable means in a timely manner, at a charge no more than the cost
|
|
182
|
+
of distribution to the recipient; and
|
|
183
|
+
|
|
184
|
+
b. You may distribute such Executable Form under the terms of this License,
|
|
185
|
+
or sublicense it under different terms, provided that the license for
|
|
186
|
+
the Executable Form does not attempt to limit or alter the recipients’
|
|
187
|
+
rights in the Source Code Form under this License.
|
|
188
|
+
|
|
189
|
+
3.3. Distribution of a Larger Work
|
|
190
|
+
|
|
191
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
192
|
+
provided that You also comply with the requirements of this License for the
|
|
193
|
+
Covered Software. If the Larger Work is a combination of Covered Software
|
|
194
|
+
with a work governed by one or more Secondary Licenses, and the Covered
|
|
195
|
+
Software is not Incompatible With Secondary Licenses, this License permits
|
|
196
|
+
You to additionally distribute such Covered Software under the terms of
|
|
197
|
+
such Secondary License(s), so that the recipient of the Larger Work may, at
|
|
198
|
+
their option, further distribute the Covered Software under the terms of
|
|
199
|
+
either this License or such Secondary License(s).
|
|
200
|
+
|
|
201
|
+
3.4. Notices
|
|
202
|
+
|
|
203
|
+
You may not remove or alter the substance of any license notices (including
|
|
204
|
+
copyright notices, patent notices, disclaimers of warranty, or limitations
|
|
205
|
+
of liability) contained within the Source Code Form of the Covered
|
|
206
|
+
Software, except that You may alter any license notices to the extent
|
|
207
|
+
required to remedy known factual inaccuracies.
|
|
208
|
+
|
|
209
|
+
3.5. Application of Additional Terms
|
|
210
|
+
|
|
211
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
212
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
213
|
+
Software. However, You may do so only on Your own behalf, and not on behalf
|
|
214
|
+
of any Contributor. You must make it absolutely clear that any such
|
|
215
|
+
warranty, support, indemnity, or liability obligation is offered by You
|
|
216
|
+
alone, and You hereby agree to indemnify every Contributor for any
|
|
217
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
218
|
+
indemnity or liability terms You offer. You may include additional
|
|
219
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
220
|
+
jurisdiction.
|
|
221
|
+
|
|
222
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
223
|
+
|
|
224
|
+
If it is impossible for You to comply with any of the terms of this License
|
|
225
|
+
with respect to some or all of the Covered Software due to statute, judicial
|
|
226
|
+
order, or regulation then You must: (a) comply with the terms of this License
|
|
227
|
+
to the maximum extent possible; and (b) describe the limitations and the code
|
|
228
|
+
they affect. Such description must be placed in a text file included with all
|
|
229
|
+
distributions of the Covered Software under this License. Except to the
|
|
230
|
+
extent prohibited by statute or regulation, such description must be
|
|
231
|
+
sufficiently detailed for a recipient of ordinary skill to be able to
|
|
232
|
+
understand it.
|
|
233
|
+
|
|
234
|
+
5. Termination
|
|
235
|
+
|
|
236
|
+
5.1. The rights granted under this License will terminate automatically if You
|
|
237
|
+
fail to comply with any of its terms. However, if You become compliant,
|
|
238
|
+
then the rights granted under this License from a particular Contributor
|
|
239
|
+
are reinstated (a) provisionally, unless and until such Contributor
|
|
240
|
+
explicitly and finally terminates Your grants, and (b) on an ongoing basis,
|
|
241
|
+
if such Contributor fails to notify You of the non-compliance by some
|
|
242
|
+
reasonable means prior to 60 days after You have come back into compliance.
|
|
243
|
+
Moreover, Your grants from a particular Contributor are reinstated on an
|
|
244
|
+
ongoing basis if such Contributor notifies You of the non-compliance by
|
|
245
|
+
some reasonable means, this is the first time You have received notice of
|
|
246
|
+
non-compliance with this License from such Contributor, and You become
|
|
247
|
+
compliant prior to 30 days after Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions, counter-claims,
|
|
251
|
+
and cross-claims) alleging that a Contributor Version directly or
|
|
252
|
+
indirectly infringes any patent, then the rights granted to You by any and
|
|
253
|
+
all Contributors for the Covered Software under Section 2.1 of this License
|
|
254
|
+
shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
|
|
257
|
+
license agreements (excluding distributors and resellers) which have been
|
|
258
|
+
validly granted by You or Your distributors under this License prior to
|
|
259
|
+
termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
6. Disclaimer of Warranty
|
|
262
|
+
|
|
263
|
+
Covered Software is provided under this License on an “as is” basis, without
|
|
264
|
+
warranty of any kind, either expressed, implied, or statutory, including,
|
|
265
|
+
without limitation, warranties that the Covered Software is free of defects,
|
|
266
|
+
merchantable, fit for a particular purpose or non-infringing. The entire
|
|
267
|
+
risk as to the quality and performance of the Covered Software is with You.
|
|
268
|
+
Should any Covered Software prove defective in any respect, You (not any
|
|
269
|
+
Contributor) assume the cost of any necessary servicing, repair, or
|
|
270
|
+
correction. This disclaimer of warranty constitutes an essential part of this
|
|
271
|
+
License. No use of any Covered Software is authorized under this License
|
|
272
|
+
except under this disclaimer.
|
|
273
|
+
|
|
274
|
+
7. Limitation of Liability
|
|
275
|
+
|
|
276
|
+
Under no circumstances and under no legal theory, whether tort (including
|
|
277
|
+
negligence), contract, or otherwise, shall any Contributor, or anyone who
|
|
278
|
+
distributes Covered Software as permitted above, be liable to You for any
|
|
279
|
+
direct, indirect, special, incidental, or consequential damages of any
|
|
280
|
+
character including, without limitation, damages for lost profits, loss of
|
|
281
|
+
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
282
|
+
other commercial damages or losses, even if such party shall have been
|
|
283
|
+
informed of the possibility of such damages. This limitation of liability
|
|
284
|
+
shall not apply to liability for death or personal injury resulting from such
|
|
285
|
+
party’s negligence to the extent applicable law prohibits such limitation.
|
|
286
|
+
Some jurisdictions do not allow the exclusion or limitation of incidental or
|
|
287
|
+
consequential damages, so this exclusion and limitation may not apply to You.
|
|
288
|
+
|
|
289
|
+
8. Litigation
|
|
290
|
+
|
|
291
|
+
Any litigation relating to this License may be brought only in the courts of
|
|
292
|
+
a jurisdiction where the defendant maintains its principal place of business
|
|
293
|
+
and such litigation shall be governed by laws of that jurisdiction, without
|
|
294
|
+
reference to its conflict-of-law provisions. Nothing in this Section shall
|
|
295
|
+
prevent a party’s ability to bring cross-claims or counter-claims.
|
|
296
|
+
|
|
297
|
+
9. Miscellaneous
|
|
298
|
+
|
|
299
|
+
This License represents the complete agreement concerning the subject matter
|
|
300
|
+
hereof. If any provision of this License is held to be unenforceable, such
|
|
301
|
+
provision shall be reformed only to the extent necessary to make it
|
|
302
|
+
enforceable. Any law or regulation which provides that the language of a
|
|
303
|
+
contract shall be construed against the drafter shall not be used to construe
|
|
304
|
+
this License against a Contributor.
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
10. Versions of the License
|
|
308
|
+
|
|
309
|
+
10.1. New Versions
|
|
310
|
+
|
|
311
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
312
|
+
10.3, no one other than the license steward has the right to modify or
|
|
313
|
+
publish new versions of this License. Each version will be given a
|
|
314
|
+
distinguishing version number.
|
|
315
|
+
|
|
316
|
+
10.2. Effect of New Versions
|
|
317
|
+
|
|
318
|
+
You may distribute the Covered Software under the terms of the version of
|
|
319
|
+
the License under which You originally received the Covered Software, or
|
|
320
|
+
under the terms of any subsequent version published by the license
|
|
321
|
+
steward.
|
|
322
|
+
|
|
323
|
+
10.3. Modified Versions
|
|
324
|
+
|
|
325
|
+
If you create software not governed by this License, and you want to
|
|
326
|
+
create a new license for such software, you may create and use a modified
|
|
327
|
+
version of this License if you rename the license and remove any
|
|
328
|
+
references to the name of the license steward (except to note that such
|
|
329
|
+
modified license differs from this License).
|
|
330
|
+
|
|
331
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
|
|
332
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
333
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
334
|
+
notice described in Exhibit B of this License must be attached.
|
|
335
|
+
|
|
336
|
+
Exhibit A - Source Code Form License Notice
|
|
337
|
+
|
|
338
|
+
This Source Code Form is subject to the
|
|
339
|
+
terms of the Mozilla Public License, v.
|
|
340
|
+
2.0. If a copy of the MPL was not
|
|
341
|
+
distributed with this file, You can
|
|
342
|
+
obtain one at
|
|
343
|
+
http://mozilla.org/MPL/2.0/.
|
|
344
|
+
|
|
345
|
+
If it is not possible or desirable to put the notice in a particular file, then
|
|
346
|
+
You may include the notice in a location (such as a LICENSE file in a relevant
|
|
347
|
+
directory) where a recipient would be likely to look for such a notice.
|
|
348
|
+
|
|
349
|
+
You may add additional accurate notices of copyright ownership.
|
|
350
|
+
|
|
351
|
+
Exhibit B - “Incompatible With Secondary Licenses” Notice
|
|
352
|
+
|
|
353
|
+
This Source Code Form is “Incompatible
|
|
354
|
+
With Secondary Licenses”, as defined by
|
|
355
|
+
the Mozilla Public License, v. 2.0.
|
package/README.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# The Future of Terraform CDK
|
|
2
|
+
|
|
3
|
+
> [!IMPORTANT]
|
|
4
|
+
>
|
|
5
|
+
> [OCF](https://the-ocf.org/) - [github.com/open-constructs](https://github.com/open-constructs) has stepped up to fork under the new name of [CDK Terrain - cdktn.io](https://cdktn.io)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Terraform CDK Provider Project
|
|
10
|
+
|
|
11
|
+
A project template for [projen](https://projen.io) to create repositories for prebuilt provider packages for [Terraform CDK](https://cdk.tf).
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
The provider repos are entirely auto generated from the configuration contained in this repo here. There's no manual interaction necessary, except for creating the initial repository - using this repo. The `cdktf get` command is executed as part of the build pipeline in Github Actions. These jobs are executed on a schedule. Hence, new provider changes will be picked up automatically.
|
|
16
|
+
|
|
17
|
+
### Creating a new provider
|
|
18
|
+
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> Only Offical Terraform Providers or Hashicorp partner Terraform Poviders will be accepted for pre-built provider generation.
|
|
21
|
+
|
|
22
|
+
Add a new repository [over here](https://github.com/cdktn-io/repository-manager).
|
|
23
|
+
|
|
24
|
+
In the newly created repository, all we need is a `.projenrc.js` file like this:
|
|
25
|
+
|
|
26
|
+
```js
|
|
27
|
+
const { CdktnProviderProject } = require('@cdktn/provider-project');
|
|
28
|
+
const { Semver } = require('projen');
|
|
29
|
+
|
|
30
|
+
const project = new CdktnProviderProject({
|
|
31
|
+
terraformProvider: "aws@~> 2.0"
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
project.synth();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Adjust the `terraformProvider` attribute as required and run the following commands:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
npm install @cdktn/provider-project@latest
|
|
41
|
+
npx projen
|
|
42
|
+
yarn install
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
This will generate an entire repository ready to be published, including Github Workflows for publishing NPM, Pypi and maven packages. The only thing which is needed to be set manually are the tokens for these registries:
|
|
46
|
+
|
|
47
|
+
- `NPM_TOKEN`
|
|
48
|
+
- `TWINE_PASSWORD`
|
|
49
|
+
- `TWINE_USERNAME`
|
|
50
|
+
|
|
51
|
+
<!-- TODO: Re-enable Maven
|
|
52
|
+
- `MAVEN_GPG_PRIVATE_KEY`
|
|
53
|
+
- `MAVEN_GPG_PRIVATE_KEY_PASSPHRASE`
|
|
54
|
+
- `MAVEN_PASSWORD`
|
|
55
|
+
- `MAVEN_USERNAME`
|
|
56
|
+
- `MAVEN_STAGING_PROFILE_ID`
|
|
57
|
+
-->
|
|
58
|
+
|
|
59
|
+
### Updating an existing Provider
|
|
60
|
+
|
|
61
|
+
Commit and push the required changes to this repository here and wait for the auto-release to happen. Once released, you can run the following commands in the target provider repository:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
npm install @cdktn/provider-project@latest
|
|
65
|
+
npx projen
|
|
66
|
+
yarn install
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Commit, push and check for the auto-released version.
|
|
70
|
+
|
|
71
|
+
## Development
|
|
72
|
+
|
|
73
|
+
Whatever needs to be changed in the downstream [provider repositories](https://github.com/cdktn-io/repository-manager) should be done via the [code definitions](./src/index.ts) here.
|
|
74
|
+
|
|
75
|
+
For local development, [yarn link](https://classic.yarnpkg.com/en/docs/cli/link/) might be quite helpful for testing.
|
|
76
|
+
|
|
77
|
+
## CAVEATS
|
|
78
|
+
|
|
79
|
+
1. Maven is disabled
|
|
80
|
+
1. Java package: com.Io.Cdktn - unusual capitalization, typically should be io.cdktn or com.cdktn
|
|
81
|
+
1. Nuget is disabled
|
|
82
|
+
1. .NET namespace: Io.Cdktn.Cdktn.Providers.Random - has "Cdktn" duplicated
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) HashiCorp, Inc.
|
|
3
|
+
* SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
*/
|
|
5
|
+
import { cdk } from "projen";
|
|
6
|
+
interface AlertOpenPrsOptions {
|
|
7
|
+
maxHoursOpen?: number;
|
|
8
|
+
slackWebhookUrl: string;
|
|
9
|
+
repository: string;
|
|
10
|
+
}
|
|
11
|
+
export declare class AlertOpenPrs {
|
|
12
|
+
constructor(project: cdk.JsiiProject, options: AlertOpenPrsOptions);
|
|
13
|
+
}
|
|
14
|
+
export {};
|