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

Update deprecation notice for push command to mention that the default source will be removed in v2.0.0 #2634

Closed
AdmiringWorm opened this issue Mar 9, 2022 · 0 comments · Fixed by #2638
Closed

Update deprecation notice for push command to mention that the default source will be removed in v2.0.0 #2634

AdmiringWorm opened this issue Mar 9, 2022 · 0 comments · Fixed by #2638
Assignees
@AdmiringWorm
Labels
5 - Released Documentation
Milestone
1.0.0

Comments

@AdmiringWorm
Copy link
Member

What You Are Seeing?

We currently have a note in for the push command that mentions that a default source will be removed in v1.0.0, however this is pushed back to v2.0.0 instead.
This note is also easily missed.

What is Expected?

As it is pushed back, it should be mentioned that it will be removed in v2.0.0 instead of v1.0.0.
It could be helpful to additionally update this note to a deprecation notice in a similar fashion as what will be in the list command:

choco/src/chocolatey/infrastructure.app/commands/ChocolateyListCommand.cs

Lines 172 to 181 in 45265d9

"chocolatey".Log().Warn(ChocolateyLoggers.Important, "DEPRECATION NOTICE");
"chocolatey".Log().Warn(@"
Starting in v2.0.0 the list command will be made local
only and will only work with the installed packages.
All options available for connecting to sources will be removed and can only
be used when using `search` or `find`.
To avoid breakage, change any calls made to remote sources to use `choco search`
or `choco find` instead. These will continue to work as usual.
");
to make it stand out a bit more.

How Did You Get This To Happen? (Steps to Reproduce)

Run choco push --help, notice there is a note that default source will be removed in v1.0.0

Output Log

N/A
@AdmiringWorm AdmiringWorm added this to the 1.0.0 milestone Mar 9, 2022
@AdmiringWorm AdmiringWorm self-assigned this Mar 9, 2022
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Mar 9, 2022
@AdmiringWorm
(chocolatey#2634) Update push command default source deprecation
1716053 
This commit updates the note about using a default source
being deprecated and removed in v1 to instead be removed
in v2.0.0.

Additionally, its own section called `DEPRECATION NOTICE`
was added to make it more visible that the functionality
will be going away.
@AdmiringWorm AdmiringWorm mentioned this issue Mar 9, 2022
Merged
8 tasks
gep13 pushed a commit to AdmiringWorm/choco that referenced this issue Mar 9, 2022
@AdmiringWorm @gep13
(chocolatey#2634) Update push command default source deprecation
b89b9bd 
This commit updates the note about using a default source
being deprecated and removed in v1 to instead be removed
in v2.0.0.

Additionally, its own section called `DEPRECATION NOTICE`
was added to make it more visible that the functionality
will be going away.
gep13 added a commit that referenced this issue Mar 9, 2022
@gep13
Merge pull request #2638 from AdmiringWorm/2634-update-deprecation-no…
d31826d 
…tice-for-push-command-to-mention-that-the-default-source-will-be-removed-in-v2.0.0

(#2634) Update push command default source deprecation
@gep13 gep13 added 4 - Done and removed 3 - Review labels Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AdmiringWorm AdmiringWorm

Labels
5 - Released Documentation
Projects
None yet
Milestone
1.0.0
2 participants
@gep13 @AdmiringWorm