feat!: add ability to customize runtime Dockerfile and build context, relativePathToWorkspace -> relativePathToPackage, remove NextjsRevalidation, replace NextjsInvalidation with NextjsPostDeploy, prune s3 and efs, see docs/breaking-changes.md (#106)

* feat: ability to customize compute image build context and Dockerfile

* fix: custom cacheHandler

* feat!: replace NextjsInvalidation with NextjsPostDeploy, add efs and s3 pruning

* fix!: remove NextjsRevalidation

* feat: reduce builder image size

* fix!: deprecate relativePathToWorkspace, replace with relativePathToPackage

* docs: turborepo example

* docs: breaking changes, update examples, e2e tests

* style: import order

* docs: comment updates

---------

Co-authored-by: Ben Stickley <stickb@amazon.com>
Co-authored-by: Ben Stickley <35735118+bestickley@users.noreply.github.com>

Author: 3 people

.eslintrc.json

@@ -7,10 +7,9 @@ env:
 
 jobs:
   check-if-should-run:
-    if: github.event.pull_request.merged == true
     runs-on: ubuntu-latest
     steps:
-      - run: echo "Workflow should run"
+      - run: echo "Workflow should run for closed PR ${{ github.event.pull_request.number }}"
   cleanup-global-functions:
     needs: check-if-should-run
     runs-on: ubuntu-latest

.gitattributes

@@ -13,24 +13,26 @@ jobs:
   # needed because we want ability to skip e2e tests sometimes via label and
   # on push to main we always want e2e tests to run
   check-if-should-run:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04-arm
     # `github.event_name == 'push'` -> will run after merge to main
     # `!contains(github.event.pull_request.labels.*.name, 'skip-e2e-tests')` -> will run when PR doesn't have label: skip-e2e-tests
     if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request_target' && !contains(github.event.pull_request.labels.*.name, 'skip-e2e-tests')) }}
     steps:
       - run: echo "Workflow should run"
 
   # needed to manually approve fork PRs since they can contain malicious code
+  # "Approve workflows to run" button does not apply to pull_request_target which
+  # is required for fork PR to access OIDC for AWS access.
   wait-for-approval:
     needs: [check-if-should-run]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04-arm
     environment: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.fork && 'manual-approval' || null }}
     steps:
       - run: echo "Workflow Approved! Starting PR Checks."
 
   glbl-fns:
     needs: wait-for-approval
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04-arm
     steps:
       - name: Checkout PR
         uses: actions/checkout@v4
@@ -45,7 +47,7 @@ jobs:
 
   glbl-cntnrs:
     needs: wait-for-approval
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04-arm
     steps:
       - name: Checkout PR
         uses: actions/checkout@v4
@@ -60,7 +62,7 @@ jobs:
 
   rgnl-cntnrs:
     needs: wait-for-approval
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest # run regional containers on x64 arch for thorough testing
     steps:
       - name: Checkout PR
         uses: actions/checkout@v4

.github/workflows/cleanup-after-merge.yml

@@ -19,14 +19,14 @@ const project = new awscdk.AwsCdkConstructLibrary({
   // majorVersion: 1,
   // prerelease: "beta",
   keywords: ["nextjs", "next", "next.js", "aws-cdk", "aws", "cdk"],
-  cdkVersion: "2.186.0",
+  cdkVersion: "2.196.0",
   jsiiVersion: "~5.8.7",
   packageManager: javascript.NodePackageManager.PNPM,
   pnpmVersion: "9",
   projenVersion: "^0.90.6",
   devDeps: [
     "@aws-crypto/sha256-js",
-    "@aws-sdk/client-sqs",
+    "@aws-sdk/client-cloudfront",
     "@aws-sdk/client-s3",
     "@aws-sdk/lib-storage",
     "@mrgrain/jsii-struct-builder",
@@ -37,7 +37,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
     "cdk-nag",
     "esbuild",
     "mime-types",
-    "next", // bundled in src/nextjs-build/cache-handler.ts
+    "next@14", // bundled in src/nextjs-build/cache-handler.ts
     "undici",
   ],
   npmIgnoreOptions: {
@@ -58,16 +58,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
     awsSdkConnectionReuse: false, // doesn't exist in AWS SDK JS v3
   },
   projenCommand: "pnpm dlx projen",
-  gitignore: [
-    ".idea",
-    ".DS_Store",
-    "cdk.out",
-    ".env",
-    "*.drawio.bkp",
-    "ash_output",
-    "examples/.dockerignore",
-    "examples/builder.Dockerfile",
-  ],
+  gitignore: [".idea", ".DS_Store", "*.drawio.bkp", "ash_output"],
   projenrcTs: true,
   eslintOptions: {
     prettier: true,
@@ -148,16 +139,11 @@ project.synth();
 
 function bundle() {
   const target = `node${nodeVersion}`;
-  project.bundler.addBundle("src/nextjs-build/cache-handler.ts", {
+  project.bundler.addBundle("src/nextjs-build/cdk-nextjs-cache-handler.ts", {
     platform: "node",
     target,
-    outfile: "../../../lib/nextjs-build/cache-handler.cjs",
-  });
-  project.bundler.addBundle("src/nextjs-build/add-cache-handler.ts", {
-    platform: "node",
-    target,
-    outfile: "../../../lib/nextjs-build/add-cache-handler.mjs",
-    format: "esm",
+    outfile: "../../../lib/nextjs-build/cdk-nextjs-cache-handler.cjs",
+    externals: ["next"],
   });
   project.bundler.addBundle("src/lambdas/assets-deployment/patch-fetch.js", {
     platform: "browser",
@@ -274,6 +260,25 @@ function updateGitHubWorkflows() {
 function generateStructs() {
   const getFilePath = (fileName: string) =>
     "src/generated-structs/" + fileName + ".ts";
+  new ProjenStruct(project, {
+    name: "OptionalNextjsPostDeployProps",
+    filePath: getFilePath("OptionalNextjsPostDeployProps"),
+  })
+    .mixin(Struct.fromFqn("cdk-nextjs.NextjsPostDeployProps"))
+    .omit("overrides")
+    .allOptional();
+  new ProjenStruct(project, {
+    name: "OptionalPostDeployCustomResourceProperties",
+    filePath: getFilePath("OptionalPostDeployCustomResourceProperties"),
+  })
+    .mixin(Struct.fromFqn("cdk-nextjs.PostDeployCustomResourceProperties"))
+    .allOptional();
+  new ProjenStruct(project, {
+    name: "OptionalCustomResourceProps",
+    filePath: getFilePath("OptionalCustomResourceProps"),
+  })
+    .mixin(Struct.fromFqn("aws-cdk-lib.CustomResourceProps"))
+    .allOptional();
   new ProjenStruct(project, {
     name: "OptionalS3OriginBucketWithOACProps",
     filePath: getFilePath("OptionalS3OriginBucketWithOACProps"),
@@ -360,13 +365,6 @@ function generateStructs() {
     .mixin(Struct.fromFqn("cdk-nextjs.NextjsContainersProps"))
     .omit("overrides")
     .allOptional();
-  new ProjenStruct(project, {
-    name: "OptionalNextjsInvalidationProps",
-    filePath: getFilePath("OptionalNextjsInvalidationProps"),
-  })
-    .mixin(Struct.fromFqn("cdk-nextjs.NextjsInvalidationProps"))
-    .omit("overrides")
-    .allOptional();
   new ProjenStruct(project, {
     name: "OptionalApplicationLoadBalancedTaskImageOptions",
     filePath: getFilePath("OptionalApplicationLoadBalancedTaskImageOptions"),