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

Clean up feature flags source files #6098

Closed
ghost opened this issue Feb 4, 2020 · 4 comments · Fixed by #6181
Closed

Clean up feature flags source files #6098

ghost opened this issue Feb 4, 2020 · 4 comments · Fixed by #6181
Assignees
@eladb
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. in-progress This issue is being actively worked on.

Comments

@ghost
Copy link

ghost commented Feb 4, 2020

The files https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/cx-api/lib/future.ts and https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/cx-api/lib/features.ts together comprise a list of the currently-supported feature flags.

Problem is, future.ts doesn't tell you what the feature flags are actually named, while features.ts lists things besides feature flags. Aside from being difficult for users to figure out, it makes it hard to link to a succinct list of feature flags (e.g. from the Feature Flags topic in the Developer Guide).

Maybe these could be unified or otherwise cleaned up.
@ghost ghost added the needs-triage This issue or PR still needs to be triaged. label Feb 4, 2020
@ghost ghost assigned eladb and ghost Feb 4, 2020
@ghost
Copy link
Author

ghost commented Feb 6, 2020

Added myself so I can make sure the right link gets into the Dev Guide once this is finalized.

eladb pushed a commit that referenced this issue Feb 9, 2020
feat(cx-api): clean up features.ts
e49a6ec 
Clean up features.ts such that it will include only things related to feature flags in order to make it easier for users to discover and add feature flags in one place. Merged it with the contents of `future.ts` and updates contribution guide to that end.

The other context keys that were in `feature.ts` were not actually feature flags but rather application switches, so these were moved to `app.ts`.

Fixes #6098
@eladb eladb mentioned this issue Feb 9, 2020
Merged
@eladb
Copy link
Contributor

eladb commented Feb 9, 2020

PR in: #6181

@eladb eladb added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. labels Feb 9, 2020
@eladb eladb unassigned ghost Feb 9, 2020
@eladb
Copy link
Contributor

eladb commented Feb 9, 2020

@jerry-aws the link you need is features.ts (which I believe is the one you already have, correct)?

@ghost
Copy link
Author

ghost commented Feb 10, 2020

Yes, the link is already correct. I'll clean up the wording around it a bit. Thanks!

@SomayaB SomayaB added in-progress This issue is being actively worked on. and removed needs-triage This issue or PR still needs to be triaged. labels Feb 10, 2020
@mergify mergify bot closed this as completed in #6181 Feb 13, 2020
mergify bot pushed a commit that referenced this issue Feb 13, 2020
feat(cx-api): clean up features.ts (#6181)
efd6f3d 
Clean up features.ts such that it will include only things related to feature flags in order to make it easier for users to discover and add feature flags in one place. Merged it with the contents of `future.ts` and updates contribution guide to that end.

The other context keys that were in `feature.ts` were not actually feature flags but rather application switches, so these were moved to `app.ts`.

Fixes #6098
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eladb eladb

Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. in-progress This issue is being actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(cx-api): clean up features.ts aws/aws-cdk
2 participants
@eladb @SomayaB