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.

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

chore(cli): fix docs #32999

Merged
merged 1 commit into from
Jan 17, 2025
Merged

chore(cli): fix docs #32999

merged 1 commit into from
Jan 17, 2025

Conversation

kaizencc
Copy link
Contributor

Caused much confusion as to whether the docs or the code was wrong. 99% sure its the docs. Will make the same changes in toolkit in a separate PR.


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

@kaizencc kaizencc requested a review from a team as a code owner January 17, 2025 21:48
@github-actions github-actions bot added the p2 label Jan 17, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team January 17, 2025 21:49
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 17, 2025
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32999/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.
❌ The title of the pull request should omit 'aws-' from the name of modified packages. Use 'cdk' instead of 'aws-cdk'.

If you believe this pull request should receive an exemption, please comment and provide a justification. A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed, add Clarification Request to a comment.

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.44%. Comparing base (4285f1e) to head (df89f33).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32999   +/-   ##
=======================================
  Coverage   81.44%   81.44%           
=======================================
  Files         225      225           
  Lines       13702    13702           
  Branches     2404     2404           
=======================================
  Hits        11160    11160           
  Misses       2267     2267           
  Partials      275      275           
Flag Coverage Δ
suite.unit 81.44% <ø> (ø)

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

Components Coverage Δ
packages/aws-cdk 80.81% <ø> (ø)
packages/aws-cdk-lib/core 82.10% <ø> (ø)

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: df89f33
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@kaizencc kaizencc changed the title chore(aws-cdk): fix docs chore(cli): fix docs Jan 17, 2025
@kaizencc kaizencc added the pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested label Jan 17, 2025
@aws-cdk-automation aws-cdk-automation dismissed their stale review January 17, 2025 22:27

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Copy link
Contributor

mergify bot commented Jan 17, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 4a76fee into main Jan 17, 2025
40 of 41 checks passed
@mergify mergify bot deleted the conroy/docfix branch January 17, 2025 22:27
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 Jan 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants