fix: include README and docs in package publishing#1510
Merged
Conversation
- 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 <noreply@anthropic.com>
- 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 <noreply@anthropic.com>
daniel-vdp
force-pushed
the
feature/fix-readme-publishing
branch
from
584732b to
588f033
Compare
- 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 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
project.jsonfiles to include README.md and documentation assets in build targetsProblem
Previously, when CDK construct packages were published to npm, README files and documentation assets were missing because they weren't included in the build output.
Solution
Added README files and documentation assets (docs/, *.png, *.jpeg) to the
assetsarray in each package'sproject.jsonbuild configuration.Test Plan
static-hostingpackage and verified README.md and docs/ directory are copied to dist/Affected Packages
All 13 packages in the monorepo:
🤖 Generated with Claude Code