From f7f2456681a2a32df54a22268ec722c6a0c0828b Mon Sep 17 00:00:00 2001 From: Daniel van der Ploeg Date: Tue, 22 Jul 2025 15:11:54 +0930 Subject: [PATCH 1/4] fix: include README and docs in package publishing MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Updated all project.json files to include README.md in build assets - Added docs/ directories and image files to assets for packages that have them - Ensures documentation is available to consumers when packages are published to npm 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- packages/basic-auth/project.json | 5 ++++- packages/cloudfront-security-headers/project.json | 5 ++++- packages/esbuild/project.json | 3 ++- packages/feature-env-handlers/project.json | 6 +++++- packages/geoip-redirect/project.json | 5 ++++- packages/graphql-mesh-server/project.json | 6 +++++- packages/header-change-detection/project.json | 6 +++++- packages/prerender-fargate/project.json | 6 +++++- packages/prerender-proxy/project.json | 5 ++++- packages/rabbitmq/project.json | 6 +++++- packages/shared-vpc/project.json | 3 ++- packages/static-hosting/project.json | 6 +++++- packages/waf/project.json | 6 +++++- 13 files changed, 55 insertions(+), 13 deletions(-) diff --git a/packages/basic-auth/project.json b/packages/basic-auth/project.json index 83c7aa23..f353de27 100644 --- a/packages/basic-auth/project.json +++ b/packages/basic-auth/project.json @@ -10,7 +10,10 @@ "main": "packages/basic-auth/index.ts", "outputPath": "dist/basic-auth", "tsConfig": "packages/basic-auth/tsconfig.app.json", - "assets": ["packages/basic-auth/lib/handlers/**"] + "assets": [ + "packages/basic-auth/lib/handlers/**", + "packages/basic-auth/README.md" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/cloudfront-security-headers/project.json b/packages/cloudfront-security-headers/project.json index 7be271a9..9963f5eb 100644 --- a/packages/cloudfront-security-headers/project.json +++ b/packages/cloudfront-security-headers/project.json @@ -10,7 +10,10 @@ "main": "packages/cloudfront-security-headers/index.ts", "outputPath": "dist/cloudfront-security-headers", "tsConfig": "packages/cloudfront-security-headers/tsconfig.app.json", - "assets": ["packages/cloudfront-security-headers/lib/handlers/**"] + "assets": [ + "packages/cloudfront-security-headers/lib/handlers/**", + "packages/cloudfront-security-headers/README.md" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/esbuild/project.json b/packages/esbuild/project.json index 2b989b88..ad23ed59 100644 --- a/packages/esbuild/project.json +++ b/packages/esbuild/project.json @@ -9,7 +9,8 @@ "options": { "main": "packages/esbuild/index.ts", "outputPath": "dist/esbuild", - "tsConfig": "packages/esbuild/tsconfig.app.json" + "tsConfig": "packages/esbuild/tsconfig.app.json", + "assets": ["packages/esbuild/README.md"] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/feature-env-handlers/project.json b/packages/feature-env-handlers/project.json index dcbf23e3..1224bdcd 100644 --- a/packages/feature-env-handlers/project.json +++ b/packages/feature-env-handlers/project.json @@ -9,7 +9,11 @@ "options": { "main": "packages/feature-env-handlers/index.ts", "outputPath": "dist/feature-env-handlers", - "tsConfig": "packages/feature-env-handlers/tsconfig.app.json" + "tsConfig": "packages/feature-env-handlers/tsconfig.app.json", + "assets": [ + "packages/feature-env-handlers/README.md", + "packages/feature-env-handlers/docs/**" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/geoip-redirect/project.json b/packages/geoip-redirect/project.json index c47c11c8..8bbaa189 100644 --- a/packages/geoip-redirect/project.json +++ b/packages/geoip-redirect/project.json @@ -10,7 +10,10 @@ "main": "packages/geoip-redirect/index.ts", "outputPath": "dist/geoip-redirect", "tsConfig": "packages/geoip-redirect/tsconfig.app.json", - "assets": ["packages/geoip-redirect/lib/handlers/**"] + "assets": [ + "packages/geoip-redirect/lib/handlers/**", + "packages/geoip-redirect/README.md" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/graphql-mesh-server/project.json b/packages/graphql-mesh-server/project.json index 7fa43e11..ff870b3f 100644 --- a/packages/graphql-mesh-server/project.json +++ b/packages/graphql-mesh-server/project.json @@ -10,7 +10,11 @@ "main": "packages/graphql-mesh-server/index.ts", "outputPath": "dist/graphql-mesh-server", "tsConfig": "packages/graphql-mesh-server/tsconfig.app.json", - "assets": ["packages/graphql-mesh-server/assets/**"] + "assets": [ + "packages/graphql-mesh-server/assets/**", + "packages/graphql-mesh-server/README.md", + "packages/graphql-mesh-server/docs/**" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/header-change-detection/project.json b/packages/header-change-detection/project.json index 0cc3f290..5e6c58e1 100644 --- a/packages/header-change-detection/project.json +++ b/packages/header-change-detection/project.json @@ -10,7 +10,11 @@ "main": "packages/header-change-detection/index.ts", "outputPath": "dist/header-change-detection", "tsConfig": "packages/header-change-detection/tsconfig.app.json", - "assets": ["packages/header-change-detection/lib/lambda/**"] + "assets": [ + "packages/header-change-detection/lib/lambda/**", + "packages/header-change-detection/README.md", + "packages/header-change-detection/docs/**" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/prerender-fargate/project.json b/packages/prerender-fargate/project.json index 7001d1ad..4bfde23c 100644 --- a/packages/prerender-fargate/project.json +++ b/packages/prerender-fargate/project.json @@ -10,7 +10,11 @@ "main": "packages/prerender-fargate/index.ts", "outputPath": "dist/prerender-fargate", "tsConfig": "packages/prerender-fargate/tsconfig.app.json", - "assets": ["packages/prerender-fargate/lib/prerender/**"] + "assets": [ + "packages/prerender-fargate/lib/prerender/**", + "packages/prerender-fargate/README.md", + "packages/prerender-fargate/tokenSecret.png" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/prerender-proxy/project.json b/packages/prerender-proxy/project.json index c8b23d8c..3f369dad 100644 --- a/packages/prerender-proxy/project.json +++ b/packages/prerender-proxy/project.json @@ -10,7 +10,10 @@ "main": "packages/prerender-proxy/index.ts", "outputPath": "dist/prerender-proxy", "tsConfig": "packages/prerender-proxy/tsconfig.app.json", - "assets": ["packages/prerender-proxy/lib/handlers/**"] + "assets": [ + "packages/prerender-proxy/lib/handlers/**", + "packages/prerender-proxy/README.md" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/rabbitmq/project.json b/packages/rabbitmq/project.json index 3aed5d23..901eb0f4 100644 --- a/packages/rabbitmq/project.json +++ b/packages/rabbitmq/project.json @@ -9,7 +9,11 @@ "options": { "main": "packages/rabbitmq/index.ts", "outputPath": "dist/rabbitmq", - "tsConfig": "packages/rabbitmq/tsconfig.app.json" + "tsConfig": "packages/rabbitmq/tsconfig.app.json", + "assets": [ + "packages/rabbitmq/README.md", + "packages/rabbitmq/CDKPipeline-RabbitMQ.jpeg" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/shared-vpc/project.json b/packages/shared-vpc/project.json index c42bd1fb..056a9714 100644 --- a/packages/shared-vpc/project.json +++ b/packages/shared-vpc/project.json @@ -9,7 +9,8 @@ "options": { "main": "packages/shared-vpc/index.ts", "outputPath": "dist/shared-vpc", - "tsConfig": "packages/shared-vpc/tsconfig.app.json" + "tsConfig": "packages/shared-vpc/tsconfig.app.json", + "assets": ["packages/shared-vpc/README.md"] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/static-hosting/project.json b/packages/static-hosting/project.json index 6bd116aa..81dbb756 100644 --- a/packages/static-hosting/project.json +++ b/packages/static-hosting/project.json @@ -10,7 +10,11 @@ "main": "packages/static-hosting/index.ts", "outputPath": "dist/static-hosting", "tsConfig": "packages/static-hosting/tsconfig.app.json", - "assets": ["packages/static-hosting/lib/handlers/**"] + "assets": [ + "packages/static-hosting/lib/handlers/**", + "packages/static-hosting/README.md", + "packages/static-hosting/docs/**" + ] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/waf/project.json b/packages/waf/project.json index a51d9a44..6f15f4e3 100644 --- a/packages/waf/project.json +++ b/packages/waf/project.json @@ -9,7 +9,11 @@ "options": { "main": "packages/waf/index.ts", "outputPath": "dist/waf", - "tsConfig": "packages/waf/tsconfig.app.json" + "tsConfig": "packages/waf/tsconfig.app.json", + "assets": [ + "packages/waf/README.md", + "packages/waf/CdkPipelineCrossAccountDeploy.jpeg" + ] }, "dependsOn": ["merge-gitignore"] }, From 588f03386d981bba5c2f11da766ceefccf7f1e69 Mon Sep 17 00:00:00 2001 From: Daniel van der Ploeg Date: Tue, 22 Jul 2025 15:27:34 +0930 Subject: [PATCH 2/4] chore: organize diagrams into docs directories MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Moved diagrams from package roots to docs/ directories for consistency - Updated README reference in prerender-fargate for moved diagram - Updated project.json assets to reference docs/ directories instead of individual files - Ensures all packages follow the same documentation structure Affected packages: - prerender-fargate: tokenSecret.png → docs/tokenSecret.png - rabbitmq: CDKPipeline-RabbitMQ.jpeg → docs/CDKPipeline-RabbitMQ.jpeg - waf: CdkPipelineCrossAccountDeploy.jpeg → docs/CdkPipelineCrossAccountDeploy.jpeg 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- packages/prerender-fargate/README.md | 2 +- .../prerender-fargate/{ => docs}/tokenSecret.png | Bin packages/prerender-fargate/project.json | 2 +- .../rabbitmq/{ => docs}/CDKPipeline-RabbitMQ.jpeg | Bin packages/rabbitmq/project.json | 2 +- .../{ => docs}/CdkPipelineCrossAccountDeploy.jpeg | Bin packages/waf/project.json | 2 +- 7 files changed, 4 insertions(+), 4 deletions(-) rename packages/prerender-fargate/{ => docs}/tokenSecret.png (100%) rename packages/rabbitmq/{ => docs}/CDKPipeline-RabbitMQ.jpeg (100%) rename packages/waf/{ => docs}/CdkPipelineCrossAccountDeploy.jpeg (100%) diff --git a/packages/prerender-fargate/README.md b/packages/prerender-fargate/README.md index 0c045559..d33bd61a 100644 --- a/packages/prerender-fargate/README.md +++ b/packages/prerender-fargate/README.md @@ -32,7 +32,7 @@ To use the PrerenderFargate construct, you can instantiate it with suitable Prer - A pre-configured AWS SecretsManager Secret name with the value being in the format of `Map`, for example, `{"token1": "https://www.example1.com,https://www.mydomain1.com", "token2":"https://www.example2.com,https://www.mydomain2.com"}`. This map is referenced for Prerender and Recaching service authentication. -![Example Secret](./tokenSecret.png "Example Secret") +![Example Secret](./docs/tokenSecret.png "Example Secret") ### `vpcId` (string, optional) diff --git a/packages/prerender-fargate/tokenSecret.png b/packages/prerender-fargate/docs/tokenSecret.png similarity index 100% rename from packages/prerender-fargate/tokenSecret.png rename to packages/prerender-fargate/docs/tokenSecret.png diff --git a/packages/prerender-fargate/project.json b/packages/prerender-fargate/project.json index 4bfde23c..e3b54ee3 100644 --- a/packages/prerender-fargate/project.json +++ b/packages/prerender-fargate/project.json @@ -13,7 +13,7 @@ "assets": [ "packages/prerender-fargate/lib/prerender/**", "packages/prerender-fargate/README.md", - "packages/prerender-fargate/tokenSecret.png" + "packages/prerender-fargate/docs/**" ] }, "dependsOn": ["merge-gitignore"] diff --git a/packages/rabbitmq/CDKPipeline-RabbitMQ.jpeg b/packages/rabbitmq/docs/CDKPipeline-RabbitMQ.jpeg similarity index 100% rename from packages/rabbitmq/CDKPipeline-RabbitMQ.jpeg rename to packages/rabbitmq/docs/CDKPipeline-RabbitMQ.jpeg diff --git a/packages/rabbitmq/project.json b/packages/rabbitmq/project.json index 901eb0f4..17d1af0b 100644 --- a/packages/rabbitmq/project.json +++ b/packages/rabbitmq/project.json @@ -12,7 +12,7 @@ "tsConfig": "packages/rabbitmq/tsconfig.app.json", "assets": [ "packages/rabbitmq/README.md", - "packages/rabbitmq/CDKPipeline-RabbitMQ.jpeg" + "packages/rabbitmq/docs/**" ] }, "dependsOn": ["merge-gitignore"] diff --git a/packages/waf/CdkPipelineCrossAccountDeploy.jpeg b/packages/waf/docs/CdkPipelineCrossAccountDeploy.jpeg similarity index 100% rename from packages/waf/CdkPipelineCrossAccountDeploy.jpeg rename to packages/waf/docs/CdkPipelineCrossAccountDeploy.jpeg diff --git a/packages/waf/project.json b/packages/waf/project.json index 6f15f4e3..292121f2 100644 --- a/packages/waf/project.json +++ b/packages/waf/project.json @@ -12,7 +12,7 @@ "tsConfig": "packages/waf/tsconfig.app.json", "assets": [ "packages/waf/README.md", - "packages/waf/CdkPipelineCrossAccountDeploy.jpeg" + "packages/waf/docs/**" ] }, "dependsOn": ["merge-gitignore"] From 11df43fb3b22f46f3d61fe1d0911bc84ef570ee0 Mon Sep 17 00:00:00 2001 From: Daniel van der Ploeg Date: Tue, 22 Jul 2025 15:36:57 +0930 Subject: [PATCH 3/4] fix: prettier formatting in project.json files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fixed multiline array formatting in rabbitmq and waf project.json files - Ensures linting passes for all packages in CI pipeline 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- packages/rabbitmq/project.json | 5 +---- packages/waf/project.json | 5 +---- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/packages/rabbitmq/project.json b/packages/rabbitmq/project.json index 17d1af0b..ceb34a75 100644 --- a/packages/rabbitmq/project.json +++ b/packages/rabbitmq/project.json @@ -10,10 +10,7 @@ "main": "packages/rabbitmq/index.ts", "outputPath": "dist/rabbitmq", "tsConfig": "packages/rabbitmq/tsconfig.app.json", - "assets": [ - "packages/rabbitmq/README.md", - "packages/rabbitmq/docs/**" - ] + "assets": ["packages/rabbitmq/README.md", "packages/rabbitmq/docs/**"] }, "dependsOn": ["merge-gitignore"] }, diff --git a/packages/waf/project.json b/packages/waf/project.json index 292121f2..3979a8d0 100644 --- a/packages/waf/project.json +++ b/packages/waf/project.json @@ -10,10 +10,7 @@ "main": "packages/waf/index.ts", "outputPath": "dist/waf", "tsConfig": "packages/waf/tsconfig.app.json", - "assets": [ - "packages/waf/README.md", - "packages/waf/docs/**" - ] + "assets": ["packages/waf/README.md", "packages/waf/docs/**"] }, "dependsOn": ["merge-gitignore"] }, From eb645e3800b50caeeb3b0db677abb61f1577f0a1 Mon Sep 17 00:00:00 2001 From: Daniel van der Ploeg Date: Tue, 22 Jul 2025 15:42:07 +0930 Subject: [PATCH 4/4] chore: retrigger CI pipeline MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude