feature-flags: redesign

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code

https://aws.amazon.com/cdk

Apache License 2.0

11.65k stars 3.91k forks source link

feature-flags: redesign #21853

Open TheRealAmazonKendra opened 2 years ago

TheRealAmazonKendra commented 2 years ago

Describe the feature

Feature flags need a redesign. Opening this issue to track this.

Use Case

User friendly flags with proper documentation so that users can easily turn on/off functionality.

Proposed Solution

TBD

Other Information

No response

Acknowledgements

[ ] I may be able to implement this feature request
[ ] This feature might incur a breaking change

CDK version used

N/A

Environment details (OS name and version, etc.)

N/A

gshpychka commented 2 years ago

Could you explain the rationale - what's wrong with the current design?

TheRealAmazonKendra commented 2 years ago

They were designed to be a temporary bandaid between v1 and v2 but they've become a permanent fixture. There is a lot of confusion about using them, the helper functions for unit testing doesn't work correctly in v2, we use commenting to do a lot of heavy lifting when defining them, and the documentation is wrong/inaccurate/incomplete in multiple places. I opened this issue to track the work I'm doing to correct all of the above.