fix: decouple workflowNodeVersion from minNodeVersion (#610)

* fix: decouple `workflowNodeVersion` from `minNodeVersion` `workflowNodeVersion` is copied from `minNodeVersion` if not set. This incentivizes undesirable behavior: `minNodeVersion` should almost never need to be set, while `workflowNodeVersion` might need to be set. As a result, users might set `minNodeVersion` while looking for the other version. Fix that in the types that wrap projen types here, in preparation of an upstream projen fix. * chore: self mutation Signed-off-by: github-actions <[email protected]> * Update documentation for copied interfaces * Also do the same for the builtin `CdkConstructLibrary` class * Fix build * chore: self mutation Signed-off-by: github-actions <[email protected]> --------- Signed-off-by: github-actions <[email protected]> Co-authored-by: github-actions <[email protected]>
cdklabs · Sep 20, 2024 · 83bc865 · 83bc865
1 parent db11391
commit 83bc865
Show file tree

Hide file tree

Showing 17 changed files with 8,147 additions and 4,337 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.gitignore b/.gitignore
diff --git a/.projen/files.json b/.projen/files.json
diff --git a/.projenrc.ts b/.projenrc.ts
@@ -1,4 +1,5 @@
 import { UpgradeDependenciesSchedule } from 'projen/lib/javascript';
+import { generateCdkConstructLibraryOptions } from './projenrc/cdk-constructlibrary-options';
 import { generateYarnMonorepoOptions } from './projenrc/yarn-monorepo-options';
 import { CdklabsJsiiProject } from './src';
 
@@ -30,6 +31,7 @@ const project = new CdklabsJsiiProject({
 });
 project.addPeerDeps('constructs@^10.0.0');
 generateYarnMonorepoOptions(project);
+generateCdkConstructLibraryOptions(project);
 
 // that is this package!
 project.deps.removeDependency(project.name);

diff --git a/API.md b/API.md
diff --git a/projenrc/cdk-constructlibrary-options.ts b/projenrc/cdk-constructlibrary-options.ts
@@ -0,0 +1,39 @@
+import { PrimitiveType } from '@jsii/spec';
+import { typescript } from 'projen';
+import { JsiiInterface } from './jsii-extend-interface';
+
+export function generateCdkConstructLibraryOptions(project: typescript.TypeScriptProject) {
+  new JsiiInterface(project, {
+    name: 'ModifiedProjenCdkConstructLibraryOptions',
+    fqn: 'cdklabs-projen-project-types.ModifiedProjenCdkConstructLibraryOptions',
+    filePath: 'src/cdk-options.ts',
+    extends: 'projen.awscdk.AwsCdkConstructLibraryOptions',
+    properties: [
+      {
+        name: 'minNodeVersion',
+        optional: true,
+        type: { primitive: PrimitiveType.String },
+        docs: {
+          summary: 'Minimum Node.js version to require via package.json `engines` (inclusive).',
+          remarks: [
+            '',
+            'Only set this if your package will not work properly on specific (older?)',
+            'Node versions.',
+            '',
+          ].join('\n'),
+          default: '- no "engines" specified',
+        },
+      },
+      {
+        name: 'workflowNodeVersion',
+        optional: true,
+        type: { primitive: PrimitiveType.String },
+        docs: {
+          summary: 'The node version to use in GitHub workflows.',
+          default: '\'lts/*\'',
+        },
+      },
+    ],
+  });
+}
+
diff --git a/projenrc/yarn-monorepo-options.ts b/projenrc/yarn-monorepo-options.ts
@@ -52,6 +52,30 @@ export function generateYarnMonorepoOptions(project: typescript.TypeScriptProjec
           summary: 'Options for the release workflows',
         },
       },
+      {
+        name: 'minNodeVersion',
+        optional: true,
+        type: { primitive: PrimitiveType.String },
+        docs: {
+          summary: 'Minimum Node.js version to require via package.json `engines` (inclusive).',
+          remarks: [
+            '',
+            'Only set this if your package will not work properly on specific (older?)',
+            'Node versions.',
+            '',
+          ].join('\n'),
+          default: '- no "engines" specified',
+        },
+      },
+      {
+        name: 'workflowNodeVersion',
+        optional: true,
+        type: { primitive: PrimitiveType.String },
+        docs: {
+          summary: 'The node version to use in GitHub workflows.',
+          default: '\'lts/*\'',
+        },
+      },
     ],
   });
 
@@ -174,6 +198,30 @@ export function generateYarnMonorepoOptions(project: typescript.TypeScriptProjec
           default: '[]',
         },
       },
+      {
+        name: 'minNodeVersion',
+        optional: true,
+        type: { primitive: PrimitiveType.String },
+        docs: {
+          summary: 'Minimum Node.js version to require via package.json `engines` (inclusive).',
+          remarks: [
+            '',
+            'Only set this if your package will not work properly on specific (older?)',
+            'Node versions.',
+            '',
+          ].join('\n'),
+          default: '- no "engines" specified',
+        },
+      },
+      {
+        name: 'workflowNodeVersion',
+        optional: true,
+        type: { primitive: PrimitiveType.String },
+        docs: {
+          summary: 'The node version to use in GitHub workflows.',
+          default: '\'lts/*\'',
+        },
+      },
     ],
   });
 }