(#2462) Add deprecation notices for list with remote sources before making it local only#2626
Merged
gep13 merged 6 commits intochocolatey:developfrom Mar 10, 2022
Conversation
AdmiringWorm
force-pushed
the
2462-Add-deprecation-notices-for-all-things-that-are-set-to-change-in-v200
branch
from
2fc8d52 to
45265d9
Compare
This commit updates the list command to deprecate the argument `--local-only` and arguments only valid for remote sources when running the list command, with a message that list will be made local only by default in v2.0.0. The same message mentions to use search or find instead for remote searches. There are additionally several messages other places to ensure that it will be difficult to miss the deprecation of remote sources when calling the list command.
gep13
force-pushed
the
2462-Add-deprecation-notices-for-all-things-that-are-set-to-change-in-v200
branch
from
45265d9 to
971290a
Compare
codeing -> coding
Previously, only search and list was shown, but makes sense to show all available aliases in the usage section.
This meant an update to the unit tests that are asserting on this message being shown.
AdmiringWorm
deleted the
2462-Add-deprecation-notices-for-all-things-that-are-set-to-change-in-v200
branch
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description Of Changes
This pull request deprecates the argument local only and the arguments only relevant when calling remote sources when the list command is used.
Additionnaly it also adds several deprecation noticed both in the help page, as well as when running the list command to ensure that users are truly notified of the change to make it local only in v2.0.0.
Motivation and Context
To make the list command only handle local/installed packages, and to notify users to the best of our ability that this change will happen.
Testing
choco list chocolateyand ensure that there is a warning mentioning the list command will be made local onlychoco list chocolatey --noopand ensure the same as step 2.choco list chocolatey --local-onlyand ensure there is no deprecation notice displayed.choco list chocolatey --local-only --noopand ensure the same as step 4.choco list --helpand ensure there is a correct deprecate notice at the top, each remote argument + local only argument is mentioned with a deprecation notice and that the alternative sources will be removed in the list command.choco search chocolateyand ensure there is no deprecation notice displayed.choco search chocolatey --noopand ensure the same as step 7.choco search chocolatey --local-onlyand ensure the same as step 7.choco search chocolatey --local-only --noopand ensure the same as step 7.choco search --helpand ensure the only deprecation notice is for the list example.findcommand.Change Types Made
Related Issue
Fixes #2462
Change Checklist