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.

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

Mark deprecated env config options #8913

Merged
merged 4 commits into from Aug 17, 2023
Merged

Conversation

viren-nadkarni
Copy link
Member

@viren-nadkarni viren-nadkarni commented Aug 15, 2023

Motivation

Some of the environment config options did not raise the deprecation warning when used. Although our docs correctly mentioned them as deprecated.

Implementation

This PR adds marks them as such.

To-do

  • Update user docs to unmark SERVICES as deprecated

Related

See localstack/docs#763 where this is synced.

@viren-nadkarni viren-nadkarni self-assigned this Aug 15, 2023
@viren-nadkarni viren-nadkarni added the semver: patch Non-breaking changes which can be included in patch releases label Aug 15, 2023
@coveralls
Copy link

coveralls commented Aug 15, 2023

Coverage Status

coverage: 81.359% (+0.3%) from 81.062% when pulling 0af888b on deprecated-options into 8d5b243 on master.

@github-actions
Copy link

github-actions bot commented Aug 15, 2023

LocalStack Community integration with Pro

       2 files         2 suites   1h 20m 14s ⏱️
2 077 tests 1 658 ✔️ 419 💤 0
2 078 runs  1 658 ✔️ 420 💤 0

Results for commit 0af888b.

♻️ This comment has been updated with latest results.

Comment on lines +239 to +243
EnvVarDeprecation(
"KINESIS_INITIALIZE_STREAMS",
"1.4.0",
"This feature is marked for removal. Please use AWS client API to seed Kinesis streams.",
),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deprecated in #7230

Comment on lines +244 to +258
EnvVarDeprecation(
"ES_CUSTOM_BACKEND",
"0.14.0",
"This option is marked for removal. Please use OPENSEARCH_CUSTOM_BACKEND instead.",
),
EnvVarDeprecation(
"ES_MULTI_CLUSTER",
"0.14.0",
"This option is marked for removal. Please use OPENSEARCH_MULTI_CLUSTER instead.",
),
EnvVarDeprecation(
"ES_ENDPOINT_STRATEGY",
"0.14.0",
"This option is marked for removal. Please use OPENSEARCH_ENDPOINT_STRATEGY instead.",
),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deprecated in #5341

Comment on lines 259 to 264
EnvVarDeprecation(
"SERVICES",
"2.0.0",
"This option is marked for removal. LocalStack lazy loads services by default. "
"You may use EAGER_SERVICE_LOADING to load all services at startup. ",
),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deprecated in #6438

@viren-nadkarni viren-nadkarni marked this pull request as ready for review August 16, 2023 10:09
Copy link
Member

@thrau thrau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@viren-nadkarni viren-nadkarni merged commit 0c9b6d4 into master Aug 17, 2023
27 checks passed
@viren-nadkarni viren-nadkarni deleted the deprecated-options branch August 17, 2023 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver: patch Non-breaking changes which can be included in patch releases
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants