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(custom-resource): update code comments to reflect actual behavior #30214

Conversation

engineer-taro
Copy link
Contributor

@engineer-taro engineer-taro commented May 15, 2024

Issue # (if applicable)

Closes #.

Reason for this change

I corrected the code comments to match the actual behavior.

Description of changes

  • Updated the default value of memorySize to 512MB to reflect that it applies when installAwsSdk is true
  • Corrected the version of the installed AWS SDK from v2 to v3

Description of how you validated changes

Since this change only involves comments, no functional testing was performed.

Checklist


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

Updated the default value of memorySize to 512MB to reflect that it applies when installAwsSdk is true
Corrected the version of the installed AWS SDK from v2 to v3
@aws-cdk-automation aws-cdk-automation requested a review from a team May 15, 2024 16:36
@github-actions github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels May 15, 2024
@engineer-taro engineer-taro changed the title chore(custom0): fix: corrected code comments chore(aws-custom-resource): Updated code comments to reflect actual behavior May 15, 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.

@engineer-taro engineer-taro changed the title chore(aws-custom-resource): Updated code comments to reflect actual behavior chore(custom-resource): Updated code comments to reflect actual behavior May 15, 2024
@engineer-taro engineer-taro changed the title chore(custom-resource): Updated code comments to reflect actual behavior chore(custom-resource): update code comments to reflect actual behavior May 15, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review May 15, 2024 16:41

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

@@ -370,7 +370,7 @@ export interface AwsCustomResourceProps {
readonly logGroup?: logs.ILogGroup;

/**
* Whether to install the latest AWS SDK v2.
* Whether to install the latest AWS SDK.
Copy link
Contributor Author

@engineer-taro engineer-taro May 15, 2024

Choose a reason for hiding this comment

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

In reality, v3 was installed.

While it would be acceptable to specify "v3", I decided not to make any specific reference to the major version, as this would require updating the code each time the major version changes.

Copy link
Contributor

Choose a reason for hiding this comment

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

@@ -344,7 +344,7 @@ export interface AwsCustomResourceProps {
/**
* The memory size for the singleton Lambda function implementing this custom resource.
*
* @default 512 mega in case if installLatestAwsSdk is false.
* @default 512 mega in case if installLatestAwsSdk is true.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looking at this implementation, the comments and the actual behavior seem to be reversed.

@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 May 15, 2024
aaythapa
aaythapa previously approved these changes May 17, 2024
Copy link
Contributor

mergify bot commented May 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 aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 17, 2024
Copy link
Contributor

mergify bot commented May 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 dismissed aaythapa’s stale review June 2, 2024 13:19

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 363fbac
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@@ -370,7 +370,7 @@ export interface AwsCustomResourceProps {
readonly logGroup?: logs.ILogGroup;

/**
* Whether to install the latest AWS SDK v2.
* Whether to install the latest AWS SDK.
Copy link
Contributor

Choose a reason for hiding this comment

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

@aws-cdk-automation
Copy link
Collaborator

This PR has been in the BUILD FAILING state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

@aws-cdk-automation
Copy link
Collaborator

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

@aws-cdk-automation aws-cdk-automation added the closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. label Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants