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(cdk-lib): fix typos #33008

Merged
merged 14 commits into from
Feb 14, 2025
Merged

docs(cdk-lib): fix typos #33008

merged 14 commits into from
Feb 14, 2025

Conversation

andyu17
Copy link
Contributor

@andyu17 andyu17 commented Jan 18, 2025

Issue # (if applicable)

Closes #.

None

Fixed typos in code comments.

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team January 18, 2025 04:55
@github-actions github-actions bot added p2 admired-contributor [Pilot] contributed between 13-24 PRs to the CDK labels Jan 18, 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:

❌ The title of this pull request does not follow the Conventional Commits format, see https://www.conventionalcommits.org/.

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.

@andyu17 andyu17 changed the title Fix s3 20250118 docs(s3): fix typos Jan 18, 2025
@aws-cdk-automation aws-cdk-automation dismissed their stale review January 18, 2025 05:00

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

Copy link

codecov bot commented Jan 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.00%. Comparing base (531280f) to head (5c3498c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #33008   +/-   ##
=======================================
  Coverage   81.00%   81.00%           
=======================================
  Files         238      238           
  Lines       14269    14269           
  Branches     2492     2492           
=======================================
  Hits        11558    11558           
  Misses       2425     2425           
  Partials      286      286           
Flag Coverage Δ
suite.unit 81.00% <ø> (ø)

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

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

@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 18, 2025
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.

Thanks for all the adjustments!
Opening a single PR for all the typos you find should help simplify the job (with a docs(cdk-lib) generic title prefix).

@@ -964,7 +964,7 @@ export abstract class BucketBase extends Resource implements IBucket {
* Function to add required permissions to the destination bucket for cross account
* replication. These permissions will be added as a resource based policy on the bucket
* @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-walkthrough-2.html
* If owner of the bucket needs to be overriden, set accessControlTransition to true and provide
* If owner of the bucket needs to be overridden, set accessControlTransition to true and provide
Copy link
Contributor

Choose a reason for hiding this comment

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

I see other 5 occurrences of this typo in the project. Can you please adjust those as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you, I fix it.

@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 Jan 18, 2025
@andyu17 andyu17 changed the title docs(s3): fix typos docs(cdk-lib): fix typos Jan 21, 2025
@lpizzinidev
Copy link
Contributor

lpizzinidev commented Jan 22, 2025

@andyu17 It seems like the linter is complaining

Screenshot 2025-01-22 at 16 18 16

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)

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 25, 2025 11:28

Dismissing outdated PRLinter review.

@aws-cdk-automation aws-cdk-automation dismissed their stale review January 28, 2025 13:12

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

@andyu17 andyu17 requested a review from lpizzinidev January 28, 2025 13:49
@lpizzinidev
Copy link
Contributor

@andyu17 This integration test seems to fail for some reason. Can you try to run it locally?

Screenshot 2025-01-28 at 17 53 06

@aaythapa
Copy link
Contributor

aaythapa commented Feb 4, 2025

@mergify update

Copy link
Contributor

mergify bot commented Feb 4, 2025

update

✅ Branch has been successfully updated

@aaythapa
Copy link
Contributor

aaythapa commented Feb 7, 2025

@mergify update

Copy link
Contributor

mergify bot commented Feb 7, 2025

update

❌ Mergify doesn't have permission to update

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/README.md without workflows permission

@aaythapa
Copy link
Contributor

aaythapa commented Feb 7, 2025

@mergify update

Copy link
Contributor

mergify bot commented Feb 7, 2025

update

✅ Branch has been successfully updated

aaythapa
aaythapa previously approved these changes Feb 13, 2025
@aaythapa
Copy link
Contributor

@mergify update

Copy link
Contributor

mergify bot commented Feb 13, 2025

update

✅ Branch has been successfully updated

Copy link
Contributor

mergify bot commented Feb 13, 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).

Copy link
Contributor

mergify bot commented Feb 13, 2025

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

@aaythapa
Copy link
Contributor

@mergify update

Copy link
Contributor

mergify bot commented Feb 14, 2025

update

☑️ Nothing to do

  • #commits-behind > 0 [📌 update requirement]
  • -closed [📌 update requirement]
  • -conflict [📌 update requirement]
  • queue-position = -1 [📌 update requirement]

@mergify mergify bot dismissed aaythapa’s stale review February 14, 2025 00:45

Pull request has been modified.

Copy link
Contributor

mergify bot commented Feb 14, 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: 5c3498c
  • 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 Feb 14, 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 e5e4f9b into aws:main Feb 14, 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 Feb 14, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
admired-contributor [Pilot] contributed between 13-24 PRs to the CDK p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants