Skip to content

fix(cli): cdk init creates README.md with wrong package manager when --package-manager option is used#989

Merged
mrgrain merged 3 commits intoaws:mainfrom
ren-yamanashi:fix/package-manager-msg
Dec 17, 2025
Merged

fix(cli): cdk init creates README.md with wrong package manager when --package-manager option is used#989
mrgrain merged 3 commits intoaws:mainfrom
ren-yamanashi:fix/package-manager-msg

Conversation

@ren-yamanashi
Copy link
Copy Markdown
Contributor

@ren-yamanashi ren-yamanashi commented Dec 12, 2025 •
edited
Loading

When initialize project using cdk init -l ts --package-manager <package-manager> command, the README.md should contain the following:

(that when selected pnpm)

* `pnpm build`   compile typescript to js
* `pnpm watch`   watch for changes and compile
* `pnpm test`    perform the jest unit tests

But actually README.md contain following:

* `npm run build`   compile typescript to js
* `npm run watch`   watch for changes and compile
* `npm run test`    perform the jest unit tests

I fixed it in this PR.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation aws-cdk-automation requested a review from a team December 12, 2025 15:01
@github-actions github-actions Bot added the p2 label Dec 12, 2025
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 12, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.45%. Comparing base (672ee1c) to head (6b72343).
⚠️ Report is 208 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #989      +/-   ##
==========================================
+ Coverage   87.40%   87.45%   +0.04%     
==========================================
  Files          72       72              
  Lines       10023    10052      +29     
  Branches     1314     1317       +3     
==========================================
+ Hits         8761     8791      +30     
+ Misses       1238     1237       -1     
  Partials       24       24
Flag Coverage Δ
suite.unit 87.45% <100.00%> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ren-yamanashi ren-yamanashi marked this pull request as ready for review December 13, 2025 00:51
@mrgrain mrgrain changed the title fix(cli): README does not support package manager being used fix(cli): cdk init generates README with wrong package manager when --package-manager option is used Dec 17, 2025
@mrgrain mrgrain changed the title fix(cli): cdk init generates README with wrong package manager when --package-manager option is used fix(cli): cdk init creates README.md with wrong package manager when --package-manager option is used Dec 17, 2025
@mrgrain mrgrain enabled auto-merge December 17, 2025 13:49
@mrgrain mrgrain added this pull request to the merge queue Dec 17, 2025
Merged via the queue into aws:main with commit db19110 Dec 17, 2025
45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mrgrain mrgrain mrgrain approved these changes

Assignees

No one assigned

Labels

p2

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ren-yamanashi @codecov-commenter @mrgrain