-
Notifications
You must be signed in to change notification settings - Fork 4k
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
fix: improve type annotation for CustomResource properties #29541
Conversation
There was a problem hiding this 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.
d618de4
to
1225f8a
Compare
Exemption Request: I don't know what an appropriate unittest would look like here, but I'm happy to add one if you suggest it. |
1225f8a
to
12fe791
Compare
This PR has been in the CHANGES REQUESTED 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. |
See above, I requested an exception. Again, happy to add unittests if someone points me in a useful direction. |
No idea if this is useful, but reposting: Exemption Request: I don't know what an appropriate unittest would look like here, but I'm happy to add one if you suggest it. |
My team just went on quite the adventure trying to figure out why JSON `false` values where getting converted to `"false"`. It would have been really nice if cdk's typing could have prevented that bug in the first place. (It would be even nicer if the underlying CloudFormation bug were fixed, but this is better than nothing)
12fe791
to
5aa92dd
Compare
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
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. |
This PR is very much not abandonded. I think these two automations are fighting with each other: I requested an exemption, and didn't get feedback before the PR was automatically closed. @aws-cdk-automation, can I get a human's eyes on this please? |
@SankyRed, I see you recently reopened a PR that was closed for staleness. Any advice about what I should do here? |
I also went through this adventure and think this could be useful. I hope this PR gets some attention. |
@aws-cdk-automation, @SankyRed, any advice about what I should do here? |
The pull request linter fails with the following errors:
PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing ✅ A exemption request has been requested. Please wait for a maintainer's review. |
Issue # (if applicable)
refs aws/aws-cdk-rfcs#375
Reason for this change
My team just went on quite the adventure trying to figure out why JSON
false
values were getting converted to"false"
. It would have been really nice if cdk's typing could have prevented that bug in the first place. (It would be even nicer if the underlying CloudFormation bug were fixed, but this is better than nothing)Description of changes
I've improved the typing of the
properties
attribute to help people realize that only strings leaves are allowed here.Description of how you validated changes
I have not tested this, hopefully the change is straightforward enough.
Checklist
of the CONTRIBUTING GUIDE as there's no unittest. I don't know what an appropriate unittest would look like here, but I'm happy to add one if you suggest it.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license