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(location): add validation for description property in PlaceIndex class #30974

Merged
merged 3 commits into from
Jul 31, 2024

Conversation

mazyu36
Copy link
Contributor

@mazyu36 mazyu36 commented Jul 29, 2024

Issue # (if applicable)

N/A

Reason for this change

Add validation for PlaceIndex description, similar to #30648, #30682, and #30711 .

Description of changes

Add validation and unit tests for description.

Description of how you validated changes

Add unit tests.

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 the p2 label Jul 29, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team July 29, 2024 16:01
@github-actions github-actions bot added the star-contributor [Pilot] contributed between 25-49 PRs to the CDK label Jul 29, 2024
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 has failed. See the aws-cdk-automation comment below for failure reasons. 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.

@mazyu36
Copy link
Contributor Author

mazyu36 commented Jul 29, 2024

Exemption Request: As this only adding validation, I think updating the README and integration tests is not needed.

@aws-cdk-automation aws-cdk-automation added pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Jul 29, 2024
Copy link
Contributor

@go-to-k go-to-k left a comment

Choose a reason for hiding this comment

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

Could you add a description for the character count constraint to JSDoc for the property? It would surely benefit users.

https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/aws-location-alpha/lib/place-index.ts#L51-L52

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 31, 2024
@mazyu36
Copy link
Contributor Author

mazyu36 commented Jul 31, 2024

@go-to-k
Thank you for the review.
I've updated docs.

@mazyu36 mazyu36 requested a review from go-to-k July 31, 2024 15:19
@TheRealAmazonKendra TheRealAmazonKendra changed the title feat(location): add validation for description property in PlaceIndex class chore(location): add validation for description property in PlaceIndex class Jul 31, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review July 31, 2024 16:55

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

Copy link
Contributor

@TheRealAmazonKendra TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

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

I've updated this to a chore, which has different validation for the PR.

Copy link
Contributor

mergify bot commented Jul 31, 2024

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: 7a63834
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit 4104043 into aws:main Jul 31, 2024
9 checks passed
Copy link
Contributor

mergify bot commented Jul 31, 2024

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).

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 Jul 31, 2024
@mazyu36 mazyu36 deleted the place-index-add-validation branch July 31, 2024 22:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
p2 pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. star-contributor [Pilot] contributed between 25-49 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants