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.

Sign up for GitHub

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

Jump to bottom

Deprecate choco config list including output from features/sources/apikeys etc #2985

Closed
2 tasks done
gep13 opened this issue Jan 19, 2023 · 1 comment
Closed
2 tasks done

Deprecate choco config list including output from features/sources/apikeys etc #2985

gep13 opened this issue Jan 19, 2023 · 1 comment
Labels
5 - Released Deprecate Features or functionality that is being deprecated in favor of removing or replacing them in future.
Milestone
1.3.0

Comments

@gep13
Copy link
Member

gep13 commented Jan 19, 2023 •
edited
Loading

Starting in Chocolatey CLI v1.3.0, we are deprecating portions of the choco config list output. Users will be warned that the features and sources sections will no longer be shown when calling config list in future versions of Chocolatey, in addition to the API keys not being shown.

To list features or sources, instead use choco feature or choco source commands, respectively.

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

It is possible to run the following commands, to get an output which includes only the things that were specifically asked for:

choco config list

choco source list

choco apikey list

However, when you run the following command:

choco config list

you get information output about all of the above, i.e. sources, features, apikeys, and configs. Additionally, in some sections, it mentions that if you want more information, run another command.

The output from the choco config list command should show only information about the config, nothing else.

Describe The Solution. Why is it needed?

This issue is about making it clear, via deprecation notices in the output, that going into the next release, choco config list output will be changing to only show config information, nothing else.

This change takes us along the path of having a consistent "API" for the Chocolatey CLI.

This will hopefully prevent confusion, and frustration, when using the Chocolatey CLI.

Additional Context

No response

Related Issues

A follow-up issue to remove the deprecation notices, and change the output of the list command has been added to the 2.0.0 milestone:
@gep13 gep13 added this to the 1.3.0 milestone Jan 19, 2023
vexx32 added a commit to vexx32/choco that referenced this issue Feb 9, 2023
@vexx32
(chocolatey#2985) Deprecate features/sources in config list
c026256 
This information is already available from the corresponding choco
commands, and cannot be altered in any way from the config command.
We plan to remove the extra information in v2.0 and confine
the data to their respective commands, so adding deprecation warnings
now.
@vexx32 vexx32 mentioned this issue Feb 9, 2023
Merged
10 tasks
vexx32 added a commit to vexx32/choco that referenced this issue Feb 10, 2023
@vexx32
(chocolatey#2985) Deprecate features/sources in config list
21e64ec 
This information is already available from the corresponding choco
commands, and cannot be altered in any way from the config command.
We plan to remove the extra information in v2.0 and confine
the data to their respective commands, so adding deprecation warnings
now.
vexx32 added a commit to vexx32/choco that referenced this issue Feb 13, 2023
@vexx32
(chocolatey#2985) Deprecate features/sources in config list
c8e9887 
This information is already available from the corresponding choco
commands, and cannot be altered in any way from the config command.
We plan to remove the extra information in v2.0 and confine
the data to their respective commands, so adding deprecation warnings
now.
vexx32 added a commit to vexx32/choco that referenced this issue Feb 13, 2023
@vexx32
(chocolatey#2985) Deprecate features/sources in config list
6583bf6 
This information is already available from the corresponding choco
commands, and cannot be altered in any way from the config command.
We plan to remove the extra information in v2.0 and confine
the data to their respective commands, so adding deprecation warnings
now.
vexx32 added a commit to vexx32/choco that referenced this issue Feb 14, 2023
@vexx32
(chocolatey#2985) Deprecate features/sources in config list
372a542 
This information is already available from the corresponding choco
commands, and cannot be altered in any way from the config command.
We plan to remove the extra information in v2.0 and confine
the data to their respective commands, so adding deprecation warnings
now.
vexx32 added a commit to vexx32/choco that referenced this issue Feb 14, 2023
@vexx32
(chocolatey#2985) Deprecate features/sources in config list
8b7d359 
This information is already available from the corresponding choco
commands, and cannot be altered in any way from the config command.
We plan to remove the extra information in v2.0 and confine
the data to their respective commands, so adding deprecation warnings
now.
corbob added a commit that referenced this issue Feb 14, 2023
@corbob
Merge pull request #3018 from vexx32/1.x-deprecations
89c678b 
(#2958, #2981, #2983, #2985) Deprecate features we plan to remove / replace after 1.x
@vexx32 vexx32 closed this as completed Feb 15, 2023
@gep13 gep13 mentioned this issue Feb 15, 2023
Closed
2 tasks
@vexx32 vexx32 added Deprecate Features or functionality that is being deprecated in favor of removing or replacing them in future. 5 - Released and removed Task 4 - Done labels Feb 15, 2023
@vexx32
Copy link
Member

vexx32 commented Feb 15, 2023

🎉 This issue has been resolved in version 1.3.0 🎉

The release is available on:

Your GitReleaseManager bot 📦🚀

gep13 added a commit that referenced this issue Feb 16, 2023
@gep13
Merge branch 'support/1.x' into develop
3e5031c 
* support/1.x:
  (#3026) Deprecate CygwinService public methods
  (#2953) CygwinService: always set RootDirectory
  (tests) Enable local source
  (maint) Remove/Fix some comments mentioning WebPI
  (#2958) Deprecate WebPI source runner
  (#2981) Deprecate install with direct file path
  (#2985) Deprecate features/sources in `config list`
  (#2983) Deprecate `--remove` option for apikey cmd
  (#2930) Update GenerateDocs.ps1 for choco-theme
  (build) Update Github workflow action versions
  (maint) Add GitReleaseManager.yaml
  (build) Add GitVersion.yml file
  (build) Add missing Criteria
  (build) Update to latest Chocolatey.Cake.Recipe
  (build) Add parameter to not build AWS projects
  (#2870) Update sln and csproj files
  (#2870) Adds No7zip build to recipe.cake

# Conflicts:
#	GenerateDocs.ps1
#	GitVersion.yml
#	gitreleasemanager.yaml
#	src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1
#	tests/chocolatey-tests/commands/choco-install.Tests.ps1
#	tests/chocolatey-tests/commands/choco-list.Tests.ps1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
5 - Released Deprecate Features or functionality that is being deprecated in favor of removing or replacing them in future.
Projects
None yet
Milestone
1.3.0
Development

No branches or pull requests
2 participants
@gep13 @vexx32