chore(ci): add workflow for upgrading jsii & typescript

.projenrc.ts

@@ -10,6 +10,7 @@ import { AutoApprove } from "./projenrc/auto-approve";
 import { Automerge } from "./projenrc/automerge";
 import { CustomizedLicense } from "./projenrc/customized-license";
 import { UpgradeCDKTF } from "./projenrc/upgrade-cdktf";
+import { UpgradeJSIIAndTypeScript } from "./projenrc/upgrade-jsii-typescript";
 
 const name = "cdktf-local-exec";
 
@@ -28,6 +29,8 @@ const githubActionPinnedVersions = {
 };
 
 const constructsVersion = "10.3.0";
+/** JSII and TSII should always use the same major/minor version range */
+const typescriptVersion = "~5.4.0";
 
 const project = new ConstructLibraryCdktf({
   author: "HashiCorp",
@@ -53,8 +56,8 @@ const project = new ConstructLibraryCdktf({
   },
   projenrcTs: true,
   prettier: true,
-  jsiiVersion: "~5.4.0",
-  typescriptVersion: "~5.4.0", // should always be the same major/minor as JSII
+  typescriptVersion,
+  jsiiVersion: typescriptVersion,
   publishToPypi: {
     distName: name,
     module: name.replace(/-/g, "_"),
@@ -67,13 +70,19 @@ new CustomizedLicense(project);
 new AutoApprove(project);
 new Automerge(project);
 new UpgradeCDKTF(project);
+new UpgradeJSIIAndTypeScript(project, typescriptVersion);
 
 project.addPeerDeps(
   "cdktf@>=0.20.0",
   "@cdktf/provider-null@>=10.0.0",
   "constructs@>=" + constructsVersion
 );
-project.addDevDeps("[email protected]", "@cdktf/provider-random@>=11.0.0");
+project.addDevDeps(
+  "semver",
+  "@types/semver",
+  "[email protected]",
+  "@cdktf/provider-random@>=11.0.0"
+);
 
 project.addPackageIgnore("scripts");
 project.addPackageIgnore("projenrc");

projenrc/upgrade-jsii-typescript.ts

@@ -0,0 +1,108 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import { javascript } from "projen";
+import { JobPermission } from "projen/lib/github/workflows-model";
+import * as semver from "semver";
+
+/**
+ * Helper script for upgrading JSII and TypeScript in the right way.
+ * This currently isn't automated (the workflow must be manually run)
+ * because there is no way to programmatically determine the EOL date
+ * of a JSII version range. This can be found at:
+ * https://github.com/aws/jsii-compiler/blob/main/README.md#gear-maintenance--support
+ */
+export class UpgradeJSIIAndTypeScript {
+  constructor(project: javascript.NodeProject, typescriptVersion: string) {
+    const workflow = project.github?.addWorkflow("upgrade-jsii-typescript");
+    if (!workflow) throw new Error("no workflow defined");
+
+    const plainVersion = typescriptVersion.replace("~", "");
+    const defaultVersion = semver.inc(plainVersion, "minor");
+
+    workflow.on({
+      workflowDispatch: {
+        inputs: {
+          newVersion: {
+            description: `New JSII/TypeScript version (e.g. "${plainVersion}"), without carets or tildes`,
+            required: true,
+            default: defaultVersion,
+            type: "string",
+          },
+        },
+      },
+    });
+
+    (workflow.concurrency as any) = {
+      group: "${{ github.workflow }}-${{ github.ref }}",
+    };
+
+    workflow.addJobs({
+      upgrade: {
+        name: "Upgrade JSII & TypeScript",
+        runsOn: ["ubuntu-latest"],
+        steps: [
+          {
+            name: "Checkout",
+            uses: "actions/checkout@v3",
+          },
+          {
+            name: "Setup Node.js",
+            uses: "actions/setup-node@v3",
+          },
+          {
+            name: "Install",
+            run: "yarn install",
+          },
+          {
+            name: "Run upgrade script",
+            run: "scripts/update-jsii-typescript.sh $NEW_VERSION",
+          },
+          {
+            name: "Get values for pull request",
+            id: "latest_version",
+            run: [
+              `NEW_VERSION_SHORT=$(cut -d "." -f 1,2 <<< "$NEW_VERSION")`,
+              `echo "value=$NEW_VERSION" >> $GITHUB_OUTPUT`,
+              `echo "short=$NEW_VERSION_SHORT" >> $GITHUB_OUTPUT`,
+            ].join("\n"),
+          },
+          {
+            name: "Create Pull Request",
+            uses: "peter-evans/create-pull-request@v3",
+            with: {
+              "commit-message":
+                "chore: upgrade jsii & typescript to v${{ steps.latest_version.outputs.short }}",
+              branch:
+                "auto/upgrade-jsii-ts-${{ steps.latest_version.outputs.short }}",
+              base: "main",
+              title:
+                "chore: upgrade jsii & typescript to v${{ steps.latest_version.outputs.short }}",
+              body: [
+                "This PR increases the version of JSII and TypeScript to `~${{ steps.latest_version.outputs.value }}`, ",
+                "presumably because the previous version is close to EOL or no longer supported. Support timeline: ",
+                "https://github.com/aws/jsii-compiler/blob/main/README.md#gear-maintenance--support",
+              ].join(" "),
+              labels: "auto-approve,automerge,automated",
+              token: "${{ secrets.PROJEN_GITHUB_TOKEN }}",
+              author: "team-tf-cdk <[email protected]>",
+              committer: "team-tf-cdk <[email protected]>",
+              signoff: true,
+              "delete-branch": true,
+            },
+          },
+        ],
+        env: {
+          CI: "true",
+          CHECKPOINT_DISABLE: "1",
+          NEW_VERSION: "${{ inputs.new_version }}", // should be newVersion but Projen converts it to snake_case
+        },
+        permissions: {
+          contents: JobPermission.READ,
+        },
+      },
+    });
+  }
+}

scripts/update-jsii-typescript.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
+set -ex
+
+PROJECT_ROOT=$(cd "$(dirname "${BASH_SOURCE:-$0}")/.." && pwd)
+NEW_VERSION=$1
+
+if [ -z "$NEW_VERSION" ]; then
+  echo "Usage: $0 <typescript-version>"
+  exit 1
+fi
+
+echo "Updating JSII & TypeScript version to $NEW_VERSION"
+yarn
+sed -i "s/typescriptVersion = \".*\";/typescriptVersion = \"~$NEW_VERSION\";/" "$PROJECT_ROOT/.projenrc.ts"
+CI=0 npx projen
+
+echo "Done"