cli/command: remove deprecated DockerCliOption, InitializeOpt #4810
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
These types were deprecated in 7af509c (v25.0), in favor of CLIOption, and are no longer used. This patch removes the deprecated type-aliases, and while updating, also improves the documentation for the CLIOption type. Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
added
impact/deprecation
status/2-code-review
kind/refactor
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4810 +/- ##
=======================================
Coverage 59.63% 59.63%
=======================================
Files 287 287
Lines 24777 24777
=======================================
Hits 14775 14775
Misses 9114 9114
Partials 888 888 |
krissetto
reviewed
Jan 23, 2024
| // CLIOption applies a modification on a DockerCli. | ||
| // CLIOption is a functional argument to apply options to a [DockerCli]. These | ||
| // options can be passed to [NewDockerCli] to initialize a new CLI, or | ||
| // applied with [DockerCli.Initialize] or [DockerCli.Apply]. |
There was a problem hiding this comment.
Just for clarity, could It make sense to mention here that it replaces the deprecated DockerCliOption/InitializeOpt types?
There was a problem hiding this comment.
I don't think we've done that before. We usually;
- Deprecate in 1 release, and add aliases to the new location (to give users a pointer where to look for the new thing)
- Remove in the release after.
Admitted; if we're gonna ramp up release cadence, then 1 release "deprecated' may potentially be too short. OTOH; if we move to Go modules, every major release is ... a major release, so technically "anything goes!"
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.
These types were deprecated in 7af509c (v25.0), in favor of CLIOption, and are no longer used.
This patch removes the deprecated type-aliases, and while updating, also improves the documentation for the CLIOption type.
With this patch:
- What I did
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)