Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

aws-cdk-lib: wrong link in help text #33566

Closed
1 task
azatoth opened this issue Feb 24, 2025 · 3 comments · Fixed by aws/aws-cdk-cli#113
Closed
1 task

aws-cdk-lib: wrong link in help text #33566

azatoth opened this issue Feb 24, 2025 · 3 comments · Fixed by aws/aws-cdk-cli#113
Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. cli Issues related to the CDK CLI effort/medium Medium work item – several days of effort p2

Comments

@azatoth
Copy link
Contributor

azatoth commented Feb 24, 2025 •
edited by pahud
Loading

Describe the bug

when running cdk gc --help, there's prominently a link pointing to https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/README.md#cdk-gc which opens up a 404.

Regression Issue

  • Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

I'm expecting the link in the help context

Garbage collect assets. Options detailed here:
https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/README.md#cdk-gc

to link to a page containing details for the options.

Current Behavior

The link points to a 404 page.

Reproduction Steps

run cdk gc --help and open the link therein

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.166.0 (build 7bb9203)

Framework Version

No response

Node.js Version

v18.20.0

OS

ubuntu

Language

Java

Language Version

No response

Other information

No response
@azatoth azatoth added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Feb 24, 2025
@github-actions github-actions bot added aws-cdk-lib Related to the aws-cdk-lib package potential-regression Marking this issue as a potential regression to be checked by team member labels Feb 24, 2025
@pahud pahud self-assigned this Feb 24, 2025
@pahud
Copy link
Contributor

pahud commented Feb 24, 2025

% npx cdk gc --help
cdk gc [ENVIRONMENTS..]

Garbage collect assets. Options detailed here:
https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/README.md#cdk-gc

Yes, we should fix this link. Thank you for the feedback.

@pahud pahud added p2 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. potential-regression Marking this issue as a potential regression to be checked by team member labels Feb 24, 2025
@pahud pahud removed their assignment Feb 24, 2025
@pahud pahud added the cli Issues related to the CDK CLI label Feb 24, 2025
@kaizencc kaizencc mentioned this issue Feb 24, 2025
Merged
@kaizencc
Copy link
Contributor

sorry, it will get updated. the new location for help is here: https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#cdk-gc

github-merge-queue bot pushed a commit to aws/aws-cdk-cli that referenced this issue Feb 24, 2025
@kaizencc @mrgrain
chore(cli): update gc link (#113)
3e228d6 
Updates link to reflect new repo name.

Fixes aws/aws-cdk#33566

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

Co-authored-by: Momo Kornher <kornherm@amazon.co.uk>
@github-actions GitHub Actions
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 24, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. cli Issues related to the CDK CLI effort/medium Medium work item – several days of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(cli): update gc link aws/aws-cdk-cli
3 participants
@azatoth @pahud @kaizencc