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.

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

Deprecate the --remove option in the apikey command #2983

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

Deprecate the --remove option in the apikey command #2983

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

Comments

@gep13
Copy link
Member

gep13 commented Jan 19, 2023

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.

Currently, you can run a command like:

choco source remove --name=chocolatey

to remove a source that is named chocolatey. However, to do the same thing with a named apikey, you have to do the following:

choco apikey --name=my-api-key --remove

This is inconsistent, and unexpected.

Describe The Solution. Why is it needed?

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.

The change associated with this issue is to mark the option as deprecated, so that folks know that a change in coming,
and a follow up issue will be created to actually remove the option in a future release of Chocolatey CLI.

Additional Context

No response

Related Issues

A follow-up issue to remove the deprecated option 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
We plan to replace this option with a proper `remove` subcommand in v2.0
so we are deprecating this now.
vexx32 added a commit to vexx32/choco that referenced this issue Feb 10, 2023
We plan to replace this option with a proper `remove` subcommand in v2.0
so we are deprecating this now.
corbob added a commit that referenced this issue Feb 14, 2023
(#2958, #2981, #2983, #2985) Deprecate features we plan to remove / replace after 1.x
@vexx32 vexx32 closed this as completed Feb 15, 2023
@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
* 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
Labels
5 - Released Deprecate Features or functionality that is being deprecated in favor of removing or replacing them in future.
Projects
None yet
Development

No branches or pull requests

2 participants