Skip to content

Commit

Permalink
(#6) Remove helpers moved to compatibility package
Browse files Browse the repository at this point in the history
This commit updates the core extension package by removing
the helpers that are available now in the compatibility package
instead.

Recommendation going forward is to take a reference on the
compatibility package instead of the core extension if
compatibility is of concern.
  • Loading branch information
AdmiringWorm committed Apr 11, 2022
1 parent 4e7bc3f commit 6bd93fc
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 147 deletions.
3 changes: 2 additions & 1 deletion src/chocolatey-core.extension/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# CHANGELOG

## 1.3.6
## 1.4.0

- Bugfix: Expand all aliases used in helper scripts ([#8](https://github.com/chocolatey-community/chocolatey-extensions/issues/8))
- Add dependency of compatibility packages to prevent breaking changes ([#7](https://github.com/chocolatey-community/chocolatey-extensions/issues/7))
- Remove `Get-PackageParameters` and `Get-UninstallRegistryKey` that are moved to [chocolatey-compatibility.extension](https://community.chocolatey.org/packages/chocolatey-compatibility.extension) package instead ([#6](https://github.com/chocolatey-community/chocolatey-extensions/issues/6))

## 1.3.5

Expand Down
18 changes: 13 additions & 5 deletions src/chocolatey-core.extension/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# chocolatey-core.extension

This is the Powershell module that extends Chocolatey with new functions.
This is a extension package that provides helper functions installed as a Chocolatey extension.
These functions may be used in Chocolatey install/uninstall scripts by declaring this package a dependency in your package's nuspec.
This package provides helper functions that can be used to enhance what is already available out of the box with Chocolatey CLI.
This includes both features that are being tested for Chocolatey CLI itself, and other helpers to make the maintenance of
Chocolatey packages easier.

Helpers that was available in this package, and laten been added to Chocolatey CLI they will be moved to
the package [chocolatey-compatibility.extension](https://community.chocolatey.org/packages/chocolatey-compatibility.extension).

Backwards compatibility is not considered for helpers available in this package, see the Notes below.

## Installation

Expand Down Expand Up @@ -40,11 +49,10 @@ To get the list of functions, load the module directly and invoke the following

To get the help for the specific function use `man`:

man Get-UninstallRegistryKey
man Get-EffectiveProxy


## Notes

- There is [a known bug](https://github.com/chocolatey-community/chocolatey-coreteampackages/issues/784) in the function `Get-AppInstallLocation` with parameter `$AppNamePattern` which is internally used both as wildcard and regex patterns. This usually doesn't create any problems, but may do so if application contains regex symbols in the name, such as [notepad++](https://github.com/chocolatey-community/chocolatey-coreteampackages/issues/1198).


- There is [a known bug](https://github.com/chocolatey-community/chocolatey-extensions/issues/11) in the function `Get-AppInstallLocation` with parameter `$AppNamePattern` which is internally used both as wildcard and regex patterns. This usually doesn't create any problems, but may do so if application contains regex symbols in the name, such as [notepad++](https://github.com/chocolatey-community/chocolatey-coreteampackages/issues/1198).
- This package itself are not concerted of keeping backwards compatibility, if compatibility is of concern take a dependency on [chocolatey-compatibility.extension](https://community.chocolatey.org/packages/chocolatey-compatibility.extension) instead
20 changes: 16 additions & 4 deletions src/chocolatey-core.extension/chocolatey-core.extension.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,27 @@
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
<metadata>
<id>chocolatey-core.extension</id>
<version>1.3.6</version>
<version>1.4.0</version>
<title>Chocolatey Core Extensions</title>
<summary>Helper functions extending core choco functionality</summary>
<authors>chocolatey</authors>
<owners>chocolatey-community</owners>
<description>
This package provides helper functions installed as a Chocolatey extension.
<description><![CDATA[This is a extension package that provides helper functions installed as a Chocolatey extension.
These functions may be used in Chocolatey install/uninstall scripts by declaring this package a dependency in your package's nuspec.
</description>
This package provides helper functions that can be used to enhance what is already available out of the box with Chocolatey CLI.
This includes both features that are being tested for Chocolatey CLI itself, and other helpers to make the maintenance of
Chocolatey packages easier.
Helpers that was available in this package, and laten been added to Chocolatey CLI they will be moved to
the package [chocolatey-compatibility.extension](https://community.chocolatey.org/packages/chocolatey-compatibility.extension).
Backwards compatibility is not considered for helpers available in this package, see the Notes below.
## Notes
- There is [a known bug](https://github.com/chocolatey-community/chocolatey-extensions/issues/11) in the function `Get-AppInstallLocation` with parameter `$AppNamePattern` which is internally used both as wildcard and regex patterns. This usually doesn't create any problems, but may do so if application contains regex symbols in the name, such as [notepad++](https://github.com/chocolatey-community/chocolatey-coreteampackages/issues/1198).
- This package itself are not concerned of keeping backwards compatibility with Chocolatey CLI, if compatibility is of concern take a dependency on [chocolatey-compatibility.extension](https://community.chocolatey.org/packages/chocolatey-compatibility.extension) instead
]]></description>
<tags>chocolatey core extension admin</tags>
<projectUrl>https://github.com/chocolatey-community/chocolatey-extensions</projectUrl>
<!--<iconUrl>http://cdn.rawgit.com/chocolatey-coreteampackages/master/icons/chocolatey-common.extension.png</iconUrl>-->
Expand Down
35 changes: 0 additions & 35 deletions src/chocolatey-core.extension/extensions/Get-PackageParameters.ps1

This file was deleted.

102 changes: 0 additions & 102 deletions src/chocolatey-core.extension/extensions/Get-UninstallRegistryKey.ps1

This file was deleted.

0 comments on commit 6bd93fc

Please sign in to comment.