services/horizon: Add deprecation warning for using command-line flags #5051
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
urvisavla
reviewed
Sep 15, 2023
sreuland
reviewed
Sep 18, 2023
urvisavla
reviewed
Oct 4, 2023
urvisavla
reviewed
Oct 4, 2023
urvisavla
reviewed
Oct 5, 2023
urvisavla
reviewed
Oct 6, 2023
urvisavla
reviewed
Oct 6, 2023
urvisavla
reviewed
Oct 6, 2023
2opremio
pushed a commit
that referenced
this pull request
Oct 16, 2023
#5051) * Add deprecated warning * Add deprecated warning tests * add test for env vars * Dynamically print deprecated message * Update flags.go * Update parameters_test.go * Update parameters_test.go * Update parameters_test.go * Update parameters_test.go * Shift environment.go to horizon package * Move environment.go to test dir * Update flags_test.go * Update flags_test.go * Update integration.go * Nit changes - 1 * Update CHANGELOG.md * Nit changes - 2 * Update flags_test.go
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.
Closes #5045
PR Checklist
PR Structure
otherwise).
services/friendbot, orallordocif the changes are broad or impact manypackages.
Thoroughness
.mdfiles, etc... affected by this change). Take a look in the
docsfolder for a given service,like this one.
Release planning
needed with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
We recommend environment variable usage in our docs. We want to deprecate command-line flag usage and remove it completely in the future. This deprecation warning will make users move towards using env vars.
Why
Currently horizon has a ton of flags and this makes using them all very cumbersome. We want to move towards using environment variables.
Known limitations
[TODO or N/A]