(#2641) Add deprecation messages for shims #2643
Merged
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
This commit updates the help text for relevant commands to mention that their shims will be removed in v2.0.0
This commit updates the generate docs helper to add a global warning for all commands mentioning that shims will be removed in v2.0.0. It also mentions which shims will be removed, and their full use.
This commit updates the whitespace and formatting for files touched to be consistent.
This commit updates the registration for the search command/alias to no longer mention it being an alias for the search command. This is done so it will look like that list and search is not the same handler, as the list command itself will be made local only in v2.0.0 This was somehow missed when deprecating the remote arguments when list is called
|
@AdmiringWorm thanks for getting this added! |
AdmiringWorm
deleted the
2641-Mark-Chocolatey-shims-chocolatey-cinst-clist-cpush-cuninst-cup-are-deprecated
branch
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.
Description Of Changes
This pull request updates the help text and documentation around the commands to mention that the shims we have available is now deprecated and will be removed in v2.0.0.
Additionally, a missed location mentioning that the search command is an alias for list is removed as these will be considered two seperate commands in v2.0.0.
Motivation and Context
To do our best to give users the information needed for future usage of the Chocolatey executable.
Testing
choco -?and notice there is a deprecation warning about shims going away.choco install -?and a mention of the shimcinstis deprecated will be shown.choco list -?and the same mention is shownchoco search -?and notice there are no deprecation notice about the shim, however there is a notice in the example of it.choco push -?and the same deprecation notice should be shown.choco uninstall -?and the same here.choco upgrade -?and this is also the same.GenerateDocs, and verify all commands have a warning that the shims are deprecated and will be removed.Change Types Made
Related Issue
fixes #2641
Small change for #2462
https://app.clickup.com/t/20540031/ENGTASKS-723
Change Checklist