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.

Sign up for GitHub

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

Jump to bottom

docs(custom-resources): complete documentation for onEvent #27512

Merged
merged 6 commits into from
Oct 18, 2023
Merged

docs(custom-resources): complete documentation for onEvent #27512

merged 6 commits into from
Oct 18, 2023

Conversation

msambol
Copy link
Contributor

@msambol msambol commented Oct 12, 2023

Closes #26892.

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 effort/small Small work item – less than a day of effort p2 labels Oct 12, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team October 12, 2023 02:18
@github-actions github-actions bot added the admired-contributor [Pilot] contributed between 13-24 PRs to the CDK label Oct 12, 2023
@msambol msambol force-pushed the custom-resource-doc branch from 52db7ae to 0a0cd4c Compare October 12, 2023 02:19
msambol
msambol commented Oct 12, 2023
View reviewed changes
packages/aws-cdk-lib/custom-resources/lib/provider-framework/runtime/framework.ts
@@ -19,7 +19,7 @@ export = {
* Any lifecycle event changes to the custom resources will invoke this handler, which will, in turn,
* interact with the user-defined `onEvent` and `isComplete` handlers.
*
* This function will always succeed. If an error occurs
* This function will always succeed. If an error occurs, it is logged but an error is not thrown.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this is correct based on my understanding of the code.

kaizencc
kaizencc previously approved these changes Oct 12, 2023
View reviewed changes
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.

Thanks! I also think this is correct :)

@kaizencc
Copy link
Contributor

@msambol uhhh i was surprised that integ tests were failing due to this change but is your change bundled into assets being used by integ tests? If so, we have to update them. However, in this rare case, I am okay with you running yarn integ --update-on-failed --dry-run since you're not touching code. The only thing that should change in integ tests are the s3 asset hash

@msambol msambol force-pushed the custom-resource-doc branch from 7246d6d to b31b279 Compare October 12, 2023 18:57
@mergify mergify bot dismissed kaizencc’s stale review October 12, 2023 18:58

Pull request has been modified.

@msambol
Copy link
Contributor Author

msambol commented Oct 12, 2023

@kaizencc Updated for your recommendations. I had to do the following:

yarn integ-runner --directory packages/@aws-cdk --update-on-failed --> from root
yarn integ --update-on-failed --dry-run --> from @aws-cdk-testing/framework-integ/test

Let me know if that isn't right.

@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 Oct 12, 2023
kaizencc
kaizencc previously approved these changes Oct 16, 2023
View reviewed changes
@mergify
Copy link
Contributor

mergify bot commented Oct 16, 2023

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 Oct 16, 2023
@mergify
Copy link
Contributor

mergify bot commented Oct 16, 2023

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 kaizencc’s stale review October 17, 2023 21:36

Pull request has been modified.

@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 Oct 17, 2023
@mergify
Copy link
Contributor

mergify bot commented Oct 17, 2023

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 Oct 17, 2023
@mergify
Copy link
Contributor

mergify bot commented Oct 17, 2023

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: 9021682
  • 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 06158f5 into aws:main Oct 18, 2023
8 checks passed
@mergify
Copy link
Contributor

mergify bot commented Oct 18, 2023

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

@github-actions github-actions bot mentioned this pull request Nov 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vinayak-kukreja vinayak-kukreja vinayak-kukreja approved these changes

@kaizencc kaizencc kaizencc left review comments

Assignees
No one assigned
Labels
admired-contributor [Pilot] contributed between 13-24 PRs to the CDK effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

aws-cdk-lib.custom_resources: unfinished comments
4 participants
@msambol @kaizencc @aws-cdk-automation @vinayak-kukreja