Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
description: This article contains release notes for the PSResourceGet module.
ms.date: 01/31/2024
ms.topic: release-notes
title: What's new in PSResourceGet?
---
# What's new in PSResourceGet?

This is a summary of changes to the **Microsoft.PowerShell.PSResourceGet** module. For a more
complete list of changes, see the [CHANGELOG][01] in the GitHub repository.

- Current preview: **Microsoft.PowerShell.PSResourceGet** v1.1.0-preview2
- Current stable release: **Microsoft.PowerShell.PSResourceGet** v1.0.5

## Release history

- v1.1.0-preview2 - Current preview release - released to the PowerShell Gallery only
- v1.1.0-preview.1 - Preview release - first shipped in PowerShell 7.5.0-preview.4
- v1.0.5 - first shipped in PowerShell 7.5.0-preview.3
- v1.0.4.1 - first shipped in PowerShell 7.4.2
- v1.0.4 - released to the PowerShell Gallery only
- v1.0.3 - released to the PowerShell Gallery only
- v1.0.2 - first shipped in PowerShell 7.5.0-preview.2
- v1.0.1 - first shipped in PowerShell 7.4.0 GA release and PowerShell 7.5.0-preview.1
- v1.0.0 - first shipped in PowerShell 7.4.0-preview.5

## Release notes

### v1.1.0-preview2 - 2024-09-13

- New cmdlet `Compress-PSResource` to create a `.nupkg` package without publishing it to a repository
system.
- Added `-Nupkg` parameter to `Publish-PSResource` to publish a `.nupkg` file to a repository.
- Added `-ModulePrefix` parameter for `Publish-PSResource`, which adds a prefix to a module name for
container registry repositories. This is only used for publishing and is not part of metadata.
- Improved error messages for Authenticode failures.
- Construct Prerelease string for repositories that don't return the prerelease information.
- Added retry logic when deleting files.

### v1.1.0-preview1 - 2024-04-01

- Added support for Azure Container Registries as a repository type
- Allowed PSResourceGet to run Constrained Languange Mode
- Fixed incorrect request URL when installing resources from ADO

### v1.0.5 - 2024-05-13

- Added 10 minute timeout to HTTPClient
- Refactor V2ServerAPICalls and NuGetServerAPICalls to use object-oriented query/filter builder
- Removed unnecessary `and` for version globbing in V2ServerAPICalls
- Fixed requiring `tags` in server response
- Fixed save script without `-IncludeXml`
- Fixed incorrect request URL when installing from ADO
- Improved exception handling
- Allowed PSResourceGet to run Constrained Languange Mode

### v1.0.4.1 - 2024-04-05

- PSResourceGet packaging update

### v1.0.4 - 2024-04-05

- Dependency package updates

### v1.0.3 - 2024-03-13

- Fixed null package version in `Install-PSResource`

### v1.0.2 - 2024-02-06

- Fixed `Update-PSResource` not updating from correct repository
- Fixed `InstalledScriptInfos` directory is now if it doesn't exist
- Fixed `Update-ModuleManifest` throwing null pointer exception
- Fixed `name` property in `PSResourceInfo` when using `Find-PSResource` with JFrog Artifactory
- Fixed incorrect configuration of requests to JFrog Artifactory v2 endpoints
- Fixed determining JFrog Artifactory repositories (#1532 Thanks @sean-r-williams!)
- Fixed for v2 server repositories incorrectly adding script endpoint (1526)
- Fixed typos in message prompts in `Install-PSResource`
- Only add `NormalizedVersion` property to `AdditionalMetadata` only when it exists
- Fix to verify whether `Uri` is a UNC path and set respective `ApiVersion`

### v1.0.1 - 2023-11-07

- Unix local user installation paths now compatible with .NET 7 and .NET 8
- Fixed `Import-PSGetRepository` in Windows PowerShell
- Fixed `Test-PSScriptFileInfo` to be less sensitive to whitespace
- Overwrite rels/rels directory on net472 when extracting nupkg to directory
- Added pipeline by property name support for **Name** and **Repository** parameters for
`Find-PSResource`

### v1.0.0 - 2023-10-09

- Add `ApiVersion` parameter for `Register-PSResourceRepository`
- Automatically set the ApiVersion to v2 for repositories imported from PowerShellGet
- Fixed ADO v2 feed installation failures
- Fixed Artifactory v2 and v3 endpoint failures
- Fixed `-RequiredResource` silent failures
- Fixed v2 repository returning extra packages for `-Tag` based search with `-Prerelease`

<!-- link references -->
[01]: https://github.com/PowerShell/PSResourceGet/tree/master/CHANGELOG
2 changes: 2 additions & 0 deletions powershell-gallery/docs-conceptual/powershellget/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ items:
href: how-to/use-acr-repository.md
- name: PSResourceGet supported repositories
href: supported-repositories.md
- name: PSResourceGet release notes
href: psresourceget-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: about PSResourceGet
# about_PSResourceGet

## Short description
Describes how to use version 1.0.5 of the **Microsoft.PowerShell.PSResourceGet**
Describes how to use version 1.1.0-preview2 of the **Microsoft.PowerShell.PSResourceGet**
module.

## Long description
Expand Down Expand Up @@ -40,6 +40,7 @@ v3 and their v2 equivalents.

| Microsoft.PowerShell.PSResourceGet | PowerShellGet v2 |
| ---------------------------------- | ------------------------- |
| `Compress-PSResource` | n/a |
| `Find-PSResource` | `Find-Command` |
| `Find-PSResource` | `Find-DscResource` |
| `Find-PSResource` | `Find-Module` |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
---
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
Module Name: Microsoft.PowerShell.PSResourceGet
ms.custom: 1.1.0-preview2
ms.date: 09/16/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/compress-psresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
schema: 2.0.0
---

# Compress-PSResource

## SYNOPSIS

Compresses a specified folder containing module or script resources into a `.nupkg` file.

## SYNTAX

```
Compress-PSResource [-Path] <String> [-DestinationPath] <String> [-PassThru] [-SkipModuleManifestValidate]
[-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION

This cmdlet compresses a specified folder containing module or script resources into a `.nupkg`
file. isolates the pack feature in the `Publish-PSResource` cmdlet. This allows you to sign the
`.nupkg` file before publishing it to a repository. You can publish the final `.nupkg` file using
the **NupkgPath** parameter of `Publish-PSResource`.

This command was added in v1.1.0-preview2 of **Microsoft.PowerShell.PSResourceGet**.

## EXAMPLES

### Example 1

This example compresses the module **TestModule** and saves te nupkg to the DestinationPath.

```powershell
Compress-PSResource -Path C:\TestModule -DestinationPath C:\NupkgDestination
```

## PARAMETERS

### -DestinationPath

Path to save the compressed resource.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PassThru

Pass the full path of the nupkg through the pipeline.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Path

Path to the resource to be compressed.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SkipModuleManifestValidate

Skips validating the module manifest before creating the `.nupkg` file.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm

Prompts you for confirmation before running the cmdlet.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.String

By default, this command doesn't write any output to the pipeline. When you use the **PassThru**
parameter, it returns full path of the `.nupkg` that was created.

## NOTES

The module defines `cmres` as an alias for `Compress-PSResource`.

This cmdlet allows for publishing nuspec dependencies into ACR.

## RELATED LINKS

[Publish-PSResource](Publish-PSResource.md)
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
Module Name: Microsoft.PowerShell.PSResourceGet
ms.custom: 1.0.5
ms.date: 05/17/2024
ms.custom: 1.1.0-preview2
ms.date: 09/16/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/find-psresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down Expand Up @@ -352,7 +352,7 @@ Specifies one or more resource types to find. Resource types supported are:
Type: Microsoft.PowerShell.PSResourceGet.UtilClasses.ResourceType
Parameter Sets: NameParameterSet
Aliases:
Accepted values: None, Module, Script
Accepted values: None, Module, Script, Nupkg

Required: False
Position: Named
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
Module Name: Microsoft.PowerShell.PSResourceGet
ms.custom: 1.0.5
ms.date: 05/17/2024
ms.custom: 1.1.0-preview2
ms.date: 09/16/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/get-installedpsresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
Module Name: Microsoft.PowerShell.PSResourceGet
ms.custom: 1.0.5
ms.date: 05/17/2024
ms.custom: 1.1.0-preview2
ms.date: 09/16/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/get-psresourcerepository?view=powershellget-3.x&WT.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
Module Name: Microsoft.PowerShell.PSResourceGet
ms.custom: 1.0.5
ms.date: 05/17/2024
ms.custom: 1.1.0-preview2
ms.date: 09/16/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/get-psscriptfileinfo?view=powershellget-3.x&WT.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
external help file: Microsoft.PowerShell.PSResourceGet.dll-help.xml
Module Name: Microsoft.PowerShell.PSResourceGet
ms.custom: 1.0.5
ms.date: 05/17/2024
ms.custom: 1.1.0-preview2
ms.date: 09/16/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/import-psgetrepository?view=powershellget-3.x&WT.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
Module Name: Microsoft.PowerShell.PSResourceGet
ms.custom: 1.0.5
ms.date: 06/07/2024
ms.custom: 1.1.0-preview2
ms.date: 09/16/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/install-psresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down
Loading
Loading