We are excited to announce that an update to our preview of PowerShellGet 3.0 is now available on the PowerShell Gallery!<\/p>\n
This release includes support for PSResourceRepository credential persistence, as well as support for RequiredResourceFiles for Install.<\/p>\n
Please ensure that you have the latest (non-prerelease) version of PowerShellGet and PackageManagement installed. To check the version you currently have installed run the command\u00a0 The latest version of PowerShellGet is 2.2.5, and the latest version of PackageManagement is 1.4.7. To install the latest versions of these modules run the following:\u00a0 To install this preview release side-by-side with your existing PowerShellGet version, open any PowerShell console and run:\u00a0 The key features and bug fixes are listed below, for the full list of changes please refer to the\u00a0Changelog<\/a>.<\/p>\n This community contributed feature allows you to provide information about where a credential is stored when registering the PSResourceRepository using a\u00a0 For this example I am going to be using SecretStore to store my credentials for an Artifactory repository. This can be repeated with any SecretManagement extension vault, and with any repository. First, I need to make sure I have a SecretManagement vault set up, with my credential stored. Currently this feature only supports the PSCredential secret type, however, we have\u00a0an issue<\/a>\u00a0to track support for other types.<\/p>\n Then I can create a PSCredentialInfo object to pass into my PSResourceRepository registration, to create this I pass in the name of the vault and the name of the secret.<\/p>\n Now I am ready to register the PSResourceRepository, I will pass in a friendly name, a URI for the repository, and the CredentialInfo. I also use the\u00a0 Now I can run\u00a0 If the repository is empty you are going to want to begin by publishing to it. I have saved my API key for publishing to the repository in my SecretStore.<\/p>\n Now I can find and install PSResources from my repository without needing to provide a credential at each call.<\/p>\n Install-PSResource can accept a path to a psd1 or json file (using -RequiredResourceFile), or a hashtable or json (using -RequiredResource).<\/p>\n The\u00a0 In this case the modules named “Configuration”, and “Pester” will be installed. The json format will be the same as if this hashtable is passed to ConvertTo-Json:<\/p>\n \u00a0Declared dependencies are searched and installed using the same trust algorithm as for Install-PSResource.<\/p>\n The\u00a0 This module is not yet feature complete. Below is a list of features which you can expect to see in the\u00a0next preview release<\/a>.<\/p>\n CompatPowerShellGet is a compatibility module that allows use of PowerShellGet 2.x (and below) cmdlet syntax with PowerShellGet 3.0 (and above) functionality by making a best effort mapping between the cmdlet interfaces of both versions of the module. New PowerShell scripts that only leverage PowerShellGet v3 cmdlets do not need to use this compatibility module. For example, if a user has the CompatPowerShellGet module installed and runs the command:<\/p>\n the CompatPowerShellGet module will get autoloaded into the PowerShell Session and will map the command to PowerShellGet 3.0 syntax:<\/p>\n The command will then be executed by the PowerShellGet 3.0 implementation. The user will also get a warning to update their script to the new cmdlet interface:<\/p>\n This module is designed so that users will not need to immediately update their scripts in order to update to the latest version of PowerShell or to begin taking advantage of the performance improvements already available in PowerShellGet 3.0. We still do recommend that authors begin making the minimal changes required to update their scripts to the new cmdlet interface.<\/p>\n This compatibility module is designed so that it takes precedence over legacy versions of PowerShellGet. If you have this compatibility module installed and would not like it to be used, you can remove it from the PowerShell session using the Remove-Module command.<\/p>\n Please note that this flow is only possible if the user has both the CompatPowerShellGet module installed and the PowerShellGet 3.0 preview module installed. Once PowerShellGet 3.0 is generally available it will be a dependency of CompatPowerShellGet.<\/p>\n Please also note that this compatibility module will not be called if you use fully qualified cmdlets. For example, if you use PowerShellGet\\Install-Module this will call a legacy version of PowerShellGet. If this is a common scenario for you, and will be a barrier to migrating to PowerShellGet 3.0 we would appreciate that feedback in\u00a0our GitHub repository<\/a>.<\/p>\n GitHub is the best place to track the bugs\/feature requests related to this module. We have used a combination of projects and labels on our GitHub repo to track issues for this upcoming release. We are using the label\u00a0 To track issues\/features for the next release, please refer to\u00a0this GitHub project<\/a>.<\/p>\n We cannot overstate how critical user feedback is at this stage in the development of the module. Feedback from preview releases help inform design decisions without incurring a breaking change once generally available and used in production.<\/p>\nGet-InstalledModule PowerShellGet, PackageManagement<\/code><\/p>\nInstall-Module PowerShellGet -Force -AllowClobber<\/code><\/p>\n<\/a>Installing the Preview<\/h3>\n
Install-Module PowerShellGet -Force -AllowPrerelease<\/code><\/p>\n<\/a>What to expect in this update<\/h2>\n
<\/a>Features of this release<\/h3>\n
\n
<\/a>Bug Fixes<\/h3>\n
\n
<\/a>Using Credential Persistence<\/h2>\n
-CredentialInfo<\/code> parameter. This parameter takes a PSCredentialInfo object which takes a vault name and secret name. The secret will then be pulled to authenticate to the Repository on Find and Install calls. This feature takes advantage of SecretManagement, for more information on SecretManagement refer the documentation<\/a>.<\/p>\n<\/a>Requirements<\/h3>\n
\n
<\/a>Getting started<\/h3>\n
PS C:\\Users > Get-SecretInfo\r\nName Type VaultName\r\n---- ---- ---------\r\njFrogCred PSCredential SecretStore\r\n<\/code><\/pre>\n<\/div>\n$credentialInfo = New-Object Microsoft.PowerShell.PowerShellGet.UtilClasses.PSCredentialInfo (\"SecretStore\", \"jfrogCred\")\r\n<\/code><\/pre>\n<\/div>\n-Trusted<\/code> switch because I will be controlling what gets published to the repository.<\/p>\nRegister-PSResourceRepository -Name artifactory `\r\n-URI \" https:\/\/<name>.jfrog.io\/artifactory\/api\/nuget\/v3\/<Repository-Name>\r\n-Trusted `\r\n-CredentialInfo $credentialInfo \r\n<\/code><\/pre>\n<\/div>\nGet-PSResourceRepository<\/code>\u00a0to see my registered repositories<\/p>\nPS C:\\Users > Get-PSResourceRepository\r\n\r\nName Uri Trusted Priority\r\n---- --- ------- --------\r\nartifactory https:\/\/<name>.jfrog.io\/artifactory\/api\/nuget\/v3\/<Repository-Name> True 50 \r\nPSGallery https:\/\/www.powershellgallery.com\/api\/v2 False 50 \r\n<\/code><\/pre>\n<\/div>\nPublish-PSResource -Path .\\Get-Hello\\ -Repository artifactory -ApiKey (Get-Secret jfrogPublish)\r\n<\/code><\/pre>\n<\/div>\nPS C:\\Users> Find-PSResource -Name Get-Hello -Repository artifactory\r\n\r\nName Version Prerelease Repository Description\r\n---- ------- ---------- ---------- -----------\r\nGet-Hello 0.0.2.0 artifactory test module\r\n\r\nPS C:\\Users> Install-PSResource Get-Hello\r\n<\/code><\/pre>\n<\/div>\n<\/a>Using Required Resources<\/h2>\n
<\/a>Getting Started<\/h3>\n
-RequiredResource<\/code>\u00a0parameter can take either a hashtable or a json format string. The following example shows how to format these inputs.<\/p>\nInstall-PSResource -RequiredResource @{\r\n 'Configuration' = @{\r\n version = '[1.3.1,2.0]'\r\n repository = 'PSGallery' \r\n }\r\n 'Pester' = @{\r\n version = '[4.4.2,4.7.0]'\r\n repository = 'PSGallery'\r\n allowPrerelease = $true\r\n }\r\n}\r\n<\/code><\/pre>\n<\/div>\n\"{\r\n 'Pester': {\r\n 'allowPrerelease': true,\r\n 'version': '[4.4.2,4.7.0]',\r\n 'repository': 'PSGallery'\r\n },\r\n 'Configuration': {\r\n 'version': '[1.3.1,2.0]',\r\n 'repository': 'PSGallery'\r\n }\r\n}\"\r\n<\/code><\/pre>\n<\/div>\n-RequiredResourceFile<\/code>\u00a0parameter can accept either a psd1 or a json file. The psd1 should use the same format as the hashtable above, the json file should use the same format as the json sting above.<\/p>\n<\/a>Features to Expect in Coming Preview Releases<\/h2>\n
\n
New-ScriptFileInfo<\/code>\u00a0cmdlet<\/li>\nTest-ScriptFileInfo<\/code>\u00a0cmdlet<\/li>\nUpdate-ScriptFileInfo<\/code>\u00a0cmdlet<\/li>\nUpdate-ModuleManifest<\/code>\u00a0cmdlet<\/li>\n-AuthenticodeCheck<\/code>\u00a0parameter switch for Save, Install, Update<\/li>\n<\/ul>\n<\/a>Using the CompatPowerShellGet module<\/h3>\n
Install-Module<\/span> PowerShellGet -<\/span>MinimumVersion 1<\/span> -<\/span>MaximumVersion 2<\/span> -<\/span>AllowPrerelease<\/pre>\n<\/div>\nInstall-PSResource<\/span> PowerShellGet -<\/span>Version \"<\/span>[1,2]\"<\/span><\/span> -<\/span>Prerelease\"<\/span> <\/span><\/pre>\n<\/div>\nWARNING: The cmdlet '<\/span>Install-Module'<\/span><\/span> is deprecated,<\/span> please use '<\/span>Install-PSResource\u2019<\/span><\/span>.<\/pre>\n<\/div>\n<\/a>How to Track the Development of this Module<\/h2>\n
Resolved-3.0<\/code>\u00a0to label issues that we plan to release at some point before we release the module as GA (generally available).<\/p>\n<\/a>How to Give feedback and Get Support<\/h2>\n