docs(ecs-patterns): remove references to REMOVE_DEFAULT_DESIRED_COUNT #29344
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
beginning-contributor
aws-cdk-automation
added
the
pr/needs-community-review
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
aws-cdk-automation
added
pr/needs-maintainer-review
kaizencc
approved these changes
Mar 4, 2024
|
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
removed
the
pr/needs-maintainer-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue # (if applicable)
Closes # 29325
Reason for this change
The
REMOVE_DEFAULT_DESIRED_COUNTfeature flag is always enabled in CDKv2, and throws builds errors if explicitly set. Theecs-patternsdocs still reference it as "opt-in", which is misleading.Ref: list of deprecated feature flags for v2
See Issue 29325 for a sample build error when trying to follow the current example code in docs for enabling the flag.
I did NOT remove the actual conditionals in the construct code, that check the (now always true) feature flag. This is dead code that can probably be removed as a chore task. My focus here was on removing friction for developers reading documentation.
Description of changes
I removed the section in the README of
ecs-patternsshowing how to manually enable this flag. I also updated the default cases in docstrings that referenced the flag.Description of how you validated changes
Doc change only, no functional changes. I did double check that the defaults described in the docstrings (when the feature flag is enabled) were still accurate.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license