chore(toolkit): add proposed initial interfaces #32643
Conversation
mrgrain
force-pushed
the
mrgrain/chore/toolkit-interfaces
branch
from
46af313 to
1194601
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #32643 +/- ##
=======================================
Coverage 80.54% 80.54%
=======================================
Files 106 106
Lines 6954 6954
Branches 1287 1287
=======================================
Hits 5601 5601
Misses 1175 1175
Partials 178 178
Flags with carried forward coverage won't be shown. Click here to find out more.
|
mrgrain
force-pushed
the
mrgrain/chore/toolkit-interfaces
branch
from
1194601 to
6f15657
Compare
aws-cdk-automation
added
the
pr/needs-maintainer-review
There was a problem hiding this comment.
because this has no impact on public surface area at all, i'm inclined to approve. but before i do, i would like to know which parts (if any) of this PR are copy/paste and which parts are new.
i also believe that eventually we should have linter rules in place that ensure all public APIs have doc strings and all optional properties have default docs. but that's not blocking for now.
| * If the app includes a single stack, returns it. Otherwise throws an exception. | ||
| * This behavior is used by "deploy". | ||
| */ | ||
| OnlySingle = 'single', |
There was a problem hiding this comment.
I'm more familiar with enums being fully capitalized, like ONLY_SINGLE. curious why the enums in this file follow a different naming scheme
| /** | ||
| * Don't select any extra stacks | ||
| */ | ||
| None, |
There was a problem hiding this comment.
Isn't it still safer to write None = 'none'?
| export enum RequireApproval { | ||
| Never = 'never', | ||
| AnyChange = 'any-change', | ||
| Broadening = 'broadening', |
There was a problem hiding this comment.
i'd like our enum styling to be the same and imo it should be fully capitalized
aws-cdk-automation
removed
the
pr/needs-maintainer-review
|
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
|
Comments on closed issues and PRs are hard for our team to see. |
Issue
Close #32567
Reason for this change
Add proposed interfaces and stub classes to the
@aws-cdk/toolkitpackage according to RFC 300, so integrators can start designing their own solution.Describe any new or updated permissions being added
n/a
Description of how you validated changes
n/a unused stub interfaces
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license