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

docs(location): specify that Map, PlaceIndex, and RouteCalculator are now legacy in README #32871

Merged
merged 6 commits into from
Jan 28, 2025

Conversation

mazyu36
Copy link
Contributor

@mazyu36 mazyu36 commented Jan 13, 2025

Issue # (if applicable)

Closes #32722.

Reason for this change

Amazon Location Service launches Enhanced Places, Routes, and Maps on Nov 8, 2024 (Ref).

New APIs for Maps, Places and Routes are launched and account-bound resources are no longer required.

Therefore, I think it’s better to mention in the README that the constructs related to these are considered legacy.

Description of changes

  • Add a section for legacy resources in the README.
  • Move the descriptions related to Map, PlaceIndex, and RouteCalculator to that section.

Describe any new or updated permissions being added

None

Description of how you validated changes

None

Checklist


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

@github-actions github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Jan 13, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team January 13, 2025 05:56
@github-actions github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Jan 13, 2025
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 13, 2025
Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.78%. Comparing base (c710e70) to head (0cdf1ff).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32871   +/-   ##
=======================================
  Coverage   80.78%   80.78%           
=======================================
  Files         232      232           
  Lines       14111    14111           
  Branches     2453     2453           
=======================================
  Hits        11400    11400           
  Misses       2431     2431           
  Partials      280      280           
Flag Coverage Δ
suite.unit 80.78% <ø> (ø)

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

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

Copy link
Contributor

@lpizzinidev lpizzinidev left a comment

Choose a reason for hiding this comment

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

👍 Not sure if the convention with methods in docs is to specify them with parenthesis or not

@aws-cdk-automation aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Jan 26, 2025
mazyu36 and others added 2 commits January 27, 2025 07:17
Co-authored-by: Luca Pizzini <[email protected]>
Co-authored-by: Luca Pizzini <[email protected]>
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.

(This review is outdated)

@aws-cdk-automation aws-cdk-automation dismissed their stale review January 26, 2025 22:52

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

@QuantumNeuralCoder QuantumNeuralCoder self-assigned this Jan 27, 2025
Copy link
Contributor

mergify bot commented Jan 28, 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).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

mergify bot commented Jan 28, 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 69b25da into aws:main Jan 28, 2025
20 checks passed
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 28, 2025
@mazyu36 mazyu36 deleted the location-legacy branch January 28, 2025 02:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
distinguished-contributor [Pilot] contributed 50+ PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr/needs-maintainer-review This PR needs a review from a Core Team Member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-location: Map, PlaceIndex and RouteCalculator constructs should be marked as legacy
5 participants