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

feat(sns): add validation of displayName for topic #30770

Merged
merged 6 commits into from
Jul 29, 2024

Conversation

sosomuse
Copy link
Contributor

@sosomuse sosomuse commented Jul 6, 2024

Issue # (if applicable)

--

Reason for this change

Display errors before deploying

Description of changes

  • Implement length check for displayName (maximum 100 characters long)

Description of how you validated changes

I added unit tests and confirmed all tests passed.

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 p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Jul 6, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team July 6, 2024 09:02
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.

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.

@sosomuse
Copy link
Contributor Author

sosomuse commented Jul 6, 2024

Exemption Request: Since this change only adds validation

@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 6, 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.

Thanks for this PR!

I think it is good to add the description to the property in the props.

export interface TopicProps {
  /**
   * A developer-defined string that can be used to identify this SNS topic.
   *
+  * The display name must be maximum 100 characters long, including hyphens (-),
+  * underscores (_), spaces, and tabs.
+  *
   * @default None
   */
  readonly displayName?: string;

The above message is from the documentation available in the CFn Guide.

@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 10, 2024
@sosomuse
Copy link
Contributor Author

@go-to-k
Thank you for the review!
I have added the description for displayName.

@sosomuse sosomuse requested a review from go-to-k July 10, 2024 10:43
@go-to-k
Copy link
Contributor

go-to-k commented Jul 10, 2024

@sosomuse

Thanks! Finally, could you please change the PR title to "feat(sns): add validation of displayName for topic"?

@sosomuse sosomuse changed the title feat(sns): add validation for displayName feat(sns): add validation of displayName for topic Jul 10, 2024
@sosomuse
Copy link
Contributor Author

@go-to-k
Done. Thank you for the suggestion.

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.

Nice @sosomuse . Approved!

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 10, 2024
@xazhao xazhao added pr-linter/exempt-readme The PR linter will not require README changes pr-linter/exempt-integ-test The PR linter will not require integ test changes and removed pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. labels Jul 26, 2024
Copy link
Contributor

@xazhao xazhao left a comment

Choose a reason for hiding this comment

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

Looks good to me. Approving. Thanks for the contribution!

@aws-cdk-automation aws-cdk-automation dismissed their stale review July 26, 2024 18:20

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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 26, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review July 26, 2024 18:20

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

Copy link
Contributor

mergify bot commented Jul 26, 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).

@sosomuse
Copy link
Contributor Author

@Mergifyio update

Copy link
Contributor

mergify bot commented Jul 29, 2024

update

✅ Branch has been successfully updated

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 6c15771
  • 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 Jul 29, 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).

@mergify mergify bot merged commit da2ec75 into aws:main Jul 29, 2024
9 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 Jul 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-readme The PR linter will not require README changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants