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(s3): updated docstring for BucketPolicy() #31395

Merged
merged 8 commits into from
Sep 17, 2024

Conversation

khushail
Copy link
Contributor

Issue #31358

Closes #31358 .

Reason for this change

Exsiting CDK Doc on BucketPolicy mentions as Prefer to use which is misleading as it does not clearly states the reprecussions.

Description of changes

I have added a sample of what would happen if this is used along with other Bucket properties.

Description of how you validated changes

This is a minor documentation change

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 bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Sep 10, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team September 10, 2024 22:27
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.

@khushail khushail changed the title Updated docstring for BucketPolicy(), explaining it reprercussions chore: Updated docstring for BucketPolicy() Sep 10, 2024
@khushail khushail changed the title chore: Updated docstring for BucketPolicy() chore: updated docstring for BucketPolicy() Sep 10, 2024
@khushail khushail changed the title chore: updated docstring for BucketPolicy() fix: updated docstring for BucketPolicy() Sep 10, 2024
@khushail khushail changed the title fix: updated docstring for BucketPolicy() fix(s3): updated docstring for BucketPolicy() Sep 10, 2024
@khushail
Copy link
Contributor Author

Exemption Request

@khushail khushail added the @aws-cdk/aws-s3 Related to Amazon S3 label Sep 11, 2024
@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Sep 11, 2024
@khushail khushail marked this pull request as ready for review September 11, 2024 16:39
@kaizencc kaizencc changed the title fix(s3): updated docstring for BucketPolicy() docs(s3): updated docstring for BucketPolicy() Sep 11, 2024
kaizencc
kaizencc previously approved these changes Sep 11, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review September 11, 2024 19:20

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

@mergify mergify bot dismissed kaizencc’s stale review September 11, 2024 19:27

Pull request has been modified.

Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

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

you keep missing linter errors on this doc change :). you can run cdk lint --fix on your local setup to make sure that it passes the linter before the PR stage.

Copy link
Contributor

mergify bot commented Sep 17, 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: e8b34c8
  • 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 f60d13b into main Sep 17, 2024
11 of 12 checks passed
Copy link
Contributor

mergify bot commented Sep 17, 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 deleted the khushail/bucketPolicy-doc-update branch September 17, 2024 15:56
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 Sep 17, 2024
@khushail
Copy link
Contributor Author

khushail commented Sep 17, 2024

you keep missing linter errors on this doc change :). you can run cdk lint --fix on your local setup to make sure that it passes the linter before the PR stage.

sounds good. will keep in mind for the next time. :) Thanks.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
@aws-cdk/aws-s3 Related to Amazon S3 bug This issue is a bug. effort/small Small work item – less than a day of effort p2 pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-s3: The autoDeleteObjects prop of Bucket is too brittle
3 participants