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

Mark Get-BinRoot Chocolatey helper function as deprecated #2470

Closed
pauby opened this issue Nov 23, 2021 · 3 comments · Fixed by #2612
Closed

Mark Get-BinRoot Chocolatey helper function as deprecated #2470

pauby opened this issue Nov 23, 2021 · 3 comments · Fixed by #2612
Assignees
@AdmiringWorm
Labels
5 - Released API Documentation IN REGRESSION TEST SUITE These are things that are handled by tools like Test-Kitchen
Milestone
1.0.0

Comments

@pauby
Copy link
Member

pauby commented Nov 23, 2021 •
edited by gep13
Loading

It's suggested that the Get-BinRoot Chocolatey helper function will be deprecated later (closer to v1). This isn't noted anywhere else.

We need to mark this Chocolatey helper as deprecated in v1.0.0.
@pauby pauby added this to the 1.0.0 milestone Nov 23, 2021
This was referenced Nov 23, 2021
Closed
Closed
@pauby pauby added API and removed Task labels Dec 23, 2021
@TheCakeIsNaOH
Copy link
Member

TheCakeIsNaOH commented Jan 17, 2022 •
edited by AdmiringWorm
Loading

Issue for documenting Get-BinRoot is deprecated: #339

@corbob corbob added the ADD AUTO TESTS Things that typically go to Test-Kitchen - once completed, IN REGRESSION TEST SUITE label added label Mar 1, 2022
@AdmiringWorm AdmiringWorm self-assigned this Mar 3, 2022
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Mar 3, 2022
@AdmiringWorm
(chocolatey#2470) Remove mentions of Get-BinRoot in templates
166feaa 
This commit updates the existing templates to
remove the mentions of Get-BinRoot as a valid
usage when creating new packages.

This is done as the alias Get-BinRoot is deprecated
in v1.0.0 and will be removed in v2.0.0.
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Mar 3, 2022
@AdmiringWorm
(chocolatey#2470) Update helper to deprecate Get-BinRoot
7f96e84 
This commit updates the Get-ToolsLocation to mention
that the alias Get-BinRoot is deprecated, as well as making
the current call to `Write-Host` to instead output a warning
that the alias is deprecated.
@AdmiringWorm AdmiringWorm mentioned this issue Mar 3, 2022
Merged
9 tasks
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Mar 7, 2022
@AdmiringWorm
(chocolatey#2470) Remove mentions of Get-BinRoot in templates
ec1e8f9 
This commit updates the existing templates to
remove the mentions of Get-BinRoot as a valid
usage when creating new packages.

This is done as the alias Get-BinRoot is deprecated
in v1.0.0 and will be removed in v2.0.0.
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Mar 7, 2022
@AdmiringWorm
(chocolatey#2470) Update helper to deprecate Get-BinRoot
83f66e4 
This commit updates the Get-ToolsLocation to mention
that the alias Get-BinRoot is deprecated, as well as making
the current call to `Write-Host` to instead output a warning
that the alias is deprecated.
gep13 pushed a commit to AdmiringWorm/choco that referenced this issue Mar 8, 2022
@AdmiringWorm @gep13
(chocolatey#2470) Remove mentions of Get-BinRoot in templates
234ad2d 
This commit updates the existing templates to
remove the mentions of Get-BinRoot as a valid
usage when creating new packages.

This is done as the alias Get-BinRoot is deprecated
in v1.0.0 and will be removed in v2.0.0.
gep13 pushed a commit to AdmiringWorm/choco that referenced this issue Mar 8, 2022
@AdmiringWorm @gep13
(chocolatey#2470) Update helper to deprecate Get-BinRoot
a012655 
This commit updates the Get-ToolsLocation to mention
that the alias Get-BinRoot is deprecated, as well as making
the current call to `Write-Host` to instead output a warning
that the alias is deprecated.
gep13 pushed a commit to AdmiringWorm/choco that referenced this issue Mar 8, 2022
@AdmiringWorm @gep13
(chocolatey#2470) Update helper to deprecate Get-BinRoot
f7447ba 
This commit updates the Get-ToolsLocation to mention
that the alias Get-BinRoot is deprecated, as well as making
the current call to `Write-Host` to instead output a warning
that the alias is deprecated.
@gep13 gep13 mentioned this issue Mar 8, 2022
Closed
@gep13
Copy link
Member

gep13 commented Mar 8, 2022

A follow up issue have been created here: #2623 under the 2.0.0 milestone, to completely remove this alias.

gep13 added a commit that referenced this issue Mar 8, 2022
@gep13
Merge pull request #2612 from AdmiringWorm/2470-Deprecate-Get-BinRoot…
1623e5f 
…-Chocolatey-helper-function

(#2470) Deprecate Get-BinRoot Chocolatey helper function
@gep13
Copy link
Member

gep13 commented Mar 8, 2022

Going to re-open this issue until the docs changes have been merged. Basically as a reminder that this needs to be done:

chocolatey/docs#401

@gep13 gep13 reopened this Mar 8, 2022
@gep13 gep13 added 4 - Done and removed 3 - Review labels Mar 8, 2022
@corbob corbob added IN REGRESSION TEST SUITE These are things that are handled by tools like Test-Kitchen and removed ADD AUTO TESTS Things that typically go to Test-Kitchen - once completed, IN REGRESSION TEST SUITE label added labels Mar 15, 2022
@gep13 gep13 changed the title Deprecate Get-BinRoot Chocolatey helper function Mark Get-BinRoot Chocolatey helper function as deprecated Mar 18, 2022
@gep13 gep13 closed this as completed Mar 21, 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 API Documentation IN REGRESSION TEST SUITE These are things that are handled by tools like Test-Kitchen
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

(#2470) Deprecate Get-BinRoot Chocolatey helper function AdmiringWorm/choco
5 participants
@gep13 @AdmiringWorm @pauby @corbob @TheCakeIsNaOH