Announcement
This repo has been deprecated. The PackageManagementProviderResource module has been merged to PackageManagement. Please use https://github.com/OneGet/oneget going forward. Thank you!
The PackageManagementProviderResource is the DSC resources for PackageManagement (aka OneGet) providers. Currently it contains the Nuget and PowerShellGet provider DSC resources to allow you to manage packages and Windows PowerShell modules.
Please check out common DSC Resources contributing guidelines.
-
PackageManagement – A generic PackageManagement provider that lets you download and install packages from any source. This provider uses Install-Package & Get-Package cmdlets. You may have to use PackageManagementSource DSC resource to register non-default sources.
-
NugetPackage – lets you download packages from the NuGet source location (e.g., http://nuget.org/api/v2/), and install or uninstall the package.
-
PSModule – lets you download Windows PowerShell modules from the PowerShell Gallery, "PSGallery" (e.g., https://www.powershellgallery.com/api/v2/ ), and install them on your computer.
-
PackageManagementSource – lets you register or unregister a package source on your computer
PackageManagement DSC resource has the following properties:
| Property | Description |
| Name | Specifies the name of the Package to be installed or uninstalled. |
| Source | Specifies the name of the package source where the package can be found. This can either be a URI or a source registered with Register-PackageSource cmdlet or PackageManagementSource DSC resource. The DSC resource MSFT_PackageManagementSource can also register a package source. |
| Ensure | Determines whether the package is to be installed or uninstalled. |
| RequiredVersion | Specifies the exact version of the package that you want to install. If you do not specify this parameter, this DSC resource installs the newest available version of the package that also satisfies any maximum version specified by the MaximumVersion parameter. |
| MinimumVersion | Specifies the minimum allowed version of the package that you want to install. If you do not add this parameter, this DSC resource intalls the highest available version of the package that also satisfies any maximum specified version specified by the MaximumVersion parameter. |
| MaximumVersion | Specifies the maximum allowed version of the package that you want to install. If you do not specify this parameter, this DSC resource installs the highest-numbered available version of the package. |
| SourceCredential | Specifies a user account that has rights to install a package for a specified package provider or source. |
| ProviderName | Specifies a package provider name to which to scope your package search. You can get package provider names by running the Get-PackageProvider cmdlet. |
| AdditionalParameters | Provider specific parameters that are passed as an Hashtable. For example, for NuGet provider you can pass additional parameters like DestinationPath. |
NugetPackage DSC resource has the following properties:
| Property | Description |
| Name | Specifies the name of the package to be installed or uninstalled. |
| DestinationPath | Specifies a file location where you want the package to be installed. |
| Ensure | Determines whether the package is to be installed or uninstalled. |
| InstallationPolicy | Determines whether you trust the package's source. |
| RequiredVersion | Specifies the exact version of the package you want to install or uninstall. |
| MinimumVersion | Specifies the minimum version of the package you want to install or uninstall. |
| MaximumVersion | Specifies the maximum version of the package you want to install or uninstall. |
| Source | Specifies the URI or name of the registered package source. |
| SourceCredential | Provides access to the package on a remote source. This property is not used to install the package. The package is always installed on the local system account. |
PSModule DSC resource has the following properties:
| Property | Description |
| Name | Specifies the name of the PowerShell module to be installed or uninstalled. |
| Ensure | Determines whether the module to be installed or uninstalled. |
| InstallationPolicy | Determines whether you trust the source repository where the module resides. |
| RequiredVersion | Specifies the exact version of the module you want to install or uninstall. |
| MinimumVersion | Specifies the minimum version of the module you want to install or uninstall. |
| Repository | Specifies the name of the module source repository where the module can found. |
PackageManagementSource has the following properties:
| Property | Description |
| Name | Specifies the name of the package source to be registered or unregistered on your system. |
| ProviderName | Specifies the name of the OneGet provider through which you can interop with the package source. |
| Ensure | Determines whether the package source is to be registered or unregistered. |
| InstallationPolicy | Determines whether you trust the package source. |
| SourceUri | Specifies the URI of the package source. |
| SourceCredential | Provides access to the package on a remote source. |
####**Requirements**####
Before you install this package, you must be running [Windows Management Framework 5.0 RTM(https://www.microsoft.com/en-us/download/details.aspx?id=50395).
####**Installation**####
To use the PackageManagementProviderResource module,
- Copy the content of the download to the $env:ProgramFiles\WindowsPowerShell\Modules folder.
To confirm installation,
- Run Get-DSCResource to verify that PackageManagement, NugetPackage, PackageManagementSource and PSModule are among the DSC Resources listed in your DSC resources.
####**Building the Code**####
The code is a Windows PowerShell script and interpreted by the Windows PowerShell engine at runtime.
####**Running Test**####
To test the modules, run the following commands. The NuGetPackage resource is used here as an example.
- cd $env:ProgramFiles\WindowsPowerShell\Modules\PackageManagementProviderResource\Test
- .\NugetPackage\NugetPackage.Get.Tests.ps1
- .\NugetPackage\NugetPackage.Set.Tests.ps1
- .\NugetPackage\NugetPackage.Test.Tests.ps1
You can repeat these commands similarly for testing PackageManagement, PSModule and PackageManagementSource DSC resources.
####**Contributing to the Code**####
You are welcome to contribute to this project. There are many ways to contribute:
-
Submit a bug report via Issues. For a guide to submitting good bug reports, please read Painless Bug Tracking.
-
Verify fixes for bugs.
-
Submit your fixes for a bug. Before submitting, please make sure you have:
- Performed code reviews of your own
- Updated the test cases if needed
- Run the test cases to ensure no feature breaks or test breaks
- Added the test cases for new code
- Submit a feature request.
- Help answer questions in the discussions list.
- Submit test cases.
- Tell others about the project.
- Tell the developers how much you appreciate the product!
You might also read these two blog posts about contributing code: Open Source Contribution Etiquette by Miguel de Icaza, and Don’t “Push” Your Pull Requests by Ilya Grigorik.
Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via Issues, and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed by the Windows PowerShell Team. Only those that meet a high bar for both quality and roadmap fit will be merged into the source.
####Examples####
Samples are included in the Examples folder.