Skip to content

Commit 10559ec

Browse files
authored
Merge pull request #159 from MicrosoftDocs/main
9/16/2024 PM Publish
2 parents d5e5299 + b837d12 commit 10559ec

22 files changed

+387
-47
lines changed
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
description: This article contains release notes for the PSResourceGet module.
3+
ms.date: 01/31/2024
4+
ms.topic: release-notes
5+
title: What's new in PSResourceGet?
6+
---
7+
# What's new in PSResourceGet?
8+
9+
This is a summary of changes to the **Microsoft.PowerShell.PSResourceGet** module. For a more
10+
complete list of changes, see the [CHANGELOG][01] in the GitHub repository.
11+
12+
- Current preview: **Microsoft.PowerShell.PSResourceGet** v1.1.0-preview2
13+
- Current stable release: **Microsoft.PowerShell.PSResourceGet** v1.0.5
14+
15+
## Release history
16+
17+
- v1.1.0-preview2 - Current preview release - released to the PowerShell Gallery only
18+
- v1.1.0-preview.1 - Preview release - first shipped in PowerShell 7.5.0-preview.4
19+
- v1.0.5 - first shipped in PowerShell 7.5.0-preview.3
20+
- v1.0.4.1 - first shipped in PowerShell 7.4.2
21+
- v1.0.4 - released to the PowerShell Gallery only
22+
- v1.0.3 - released to the PowerShell Gallery only
23+
- v1.0.2 - first shipped in PowerShell 7.5.0-preview.2
24+
- v1.0.1 - first shipped in PowerShell 7.4.0 GA release and PowerShell 7.5.0-preview.1
25+
- v1.0.0 - first shipped in PowerShell 7.4.0-preview.5
26+
27+
## Release notes
28+
29+
### v1.1.0-preview2 - 2024-09-13
30+
31+
- New cmdlet `Compress-PSResource` to create a `.nupkg` package without publishing it to a repository
32+
system.
33+
- Added `-Nupkg` parameter to `Publish-PSResource` to publish a `.nupkg` file to a repository.
34+
- Added `-ModulePrefix` parameter for `Publish-PSResource`, which adds a prefix to a module name for
35+
container registry repositories. This is only used for publishing and is not part of metadata.
36+
- Improved error messages for Authenticode failures.
37+
- Construct Prerelease string for repositories that don't return the prerelease information.
38+
- Added retry logic when deleting files.
39+
40+
### v1.1.0-preview1 - 2024-04-01
41+
42+
- Added support for Azure Container Registries as a repository type
43+
- Allowed PSResourceGet to run Constrained Languange Mode
44+
- Fixed incorrect request URL when installing resources from ADO
45+
46+
### v1.0.5 - 2024-05-13
47+
48+
- Added 10 minute timeout to HTTPClient
49+
- Refactor V2ServerAPICalls and NuGetServerAPICalls to use object-oriented query/filter builder
50+
- Removed unnecessary `and` for version globbing in V2ServerAPICalls
51+
- Fixed requiring `tags` in server response
52+
- Fixed save script without `-IncludeXml`
53+
- Fixed incorrect request URL when installing from ADO
54+
- Improved exception handling
55+
- Allowed PSResourceGet to run Constrained Languange Mode
56+
57+
### v1.0.4.1 - 2024-04-05
58+
59+
- PSResourceGet packaging update
60+
61+
### v1.0.4 - 2024-04-05
62+
63+
- Dependency package updates
64+
65+
### v1.0.3 - 2024-03-13
66+
67+
- Fixed null package version in `Install-PSResource`
68+
69+
### v1.0.2 - 2024-02-06
70+
71+
- Fixed `Update-PSResource` not updating from correct repository
72+
- Fixed `InstalledScriptInfos` directory is now if it doesn't exist
73+
- Fixed `Update-ModuleManifest` throwing null pointer exception
74+
- Fixed `name` property in `PSResourceInfo` when using `Find-PSResource` with JFrog Artifactory
75+
- Fixed incorrect configuration of requests to JFrog Artifactory v2 endpoints
76+
- Fixed determining JFrog Artifactory repositories (#1532 Thanks @sean-r-williams!)
77+
- Fixed for v2 server repositories incorrectly adding script endpoint (1526)
78+
- Fixed typos in message prompts in `Install-PSResource`
79+
- Only add `NormalizedVersion` property to `AdditionalMetadata` only when it exists
80+
- Fix to verify whether `Uri` is a UNC path and set respective `ApiVersion`
81+
82+
### v1.0.1 - 2023-11-07
83+
84+
- Unix local user installation paths now compatible with .NET 7 and .NET 8
85+
- Fixed `Import-PSGetRepository` in Windows PowerShell
86+
- Fixed `Test-PSScriptFileInfo` to be less sensitive to whitespace
87+
- Overwrite rels/rels directory on net472 when extracting nupkg to directory
88+
- Added pipeline by property name support for **Name** and **Repository** parameters for
89+
`Find-PSResource`
90+
91+
### v1.0.0 - 2023-10-09
92+
93+
- Add `ApiVersion` parameter for `Register-PSResourceRepository`
94+
- Automatically set the ApiVersion to v2 for repositories imported from PowerShellGet
95+
- Fixed ADO v2 feed installation failures
96+
- Fixed Artifactory v2 and v3 endpoint failures
97+
- Fixed `-RequiredResource` silent failures
98+
- Fixed v2 repository returning extra packages for `-Tag` based search with `-Prerelease`
99+
100+
<!-- link references -->
101+
[01]: https://github.com/PowerShell/PSResourceGet/tree/master/CHANGELOG

powershell-gallery/docs-conceptual/powershellget/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ items:
1515
href: how-to/use-acr-repository.md
1616
- name: PSResourceGet supported repositories
1717
href: supported-repositories.md
18+
- name: PSResourceGet release notes
19+
href: psresourceget-release-notes.md

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/About/about_PSResourceGet.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: about PSResourceGet
1010
# about_PSResourceGet
1111

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

1616
## Long description
@@ -40,6 +40,7 @@ v3 and their v2 equivalents.
4040

4141
| Microsoft.PowerShell.PSResourceGet | PowerShellGet v2 |
4242
| ---------------------------------- | ------------------------- |
43+
| `Compress-PSResource` | n/a |
4344
| `Find-PSResource` | `Find-Command` |
4445
| `Find-PSResource` | `Find-DscResource` |
4546
| `Find-PSResource` | `Find-Module` |
Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
3+
Module Name: Microsoft.PowerShell.PSResourceGet
4+
ms.custom: 1.1.0-preview2
5+
ms.date: 09/16/2024
6+
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/compress-psresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
---
9+
10+
# Compress-PSResource
11+
12+
## SYNOPSIS
13+
14+
Compresses a specified folder containing module or script resources into a `.nupkg` file.
15+
16+
## SYNTAX
17+
18+
```
19+
Compress-PSResource [-Path] <String> [-DestinationPath] <String> [-PassThru] [-SkipModuleManifestValidate]
20+
[-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
This cmdlet compresses a specified folder containing module or script resources into a `.nupkg`
26+
file. isolates the pack feature in the `Publish-PSResource` cmdlet. This allows you to sign the
27+
`.nupkg` file before publishing it to a repository. You can publish the final `.nupkg` file using
28+
the **NupkgPath** parameter of `Publish-PSResource`.
29+
30+
This command was added in v1.1.0-preview2 of **Microsoft.PowerShell.PSResourceGet**.
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
36+
This example compresses the module **TestModule** and saves te nupkg to the DestinationPath.
37+
38+
```powershell
39+
Compress-PSResource -Path C:\TestModule -DestinationPath C:\NupkgDestination
40+
```
41+
42+
## PARAMETERS
43+
44+
### -DestinationPath
45+
46+
Path to save the compressed resource.
47+
48+
```yaml
49+
Type: System.String
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: True
54+
Position: 1
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -PassThru
61+
62+
Pass the full path of the nupkg through the pipeline.
63+
64+
```yaml
65+
Type: System.Management.Automation.SwitchParameter
66+
Parameter Sets: (All)
67+
Aliases:
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -Path
77+
78+
Path to the resource to be compressed.
79+
80+
```yaml
81+
Type: System.String
82+
Parameter Sets: (All)
83+
Aliases:
84+
85+
Required: True
86+
Position: 0
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### -SkipModuleManifestValidate
93+
94+
Skips validating the module manifest before creating the `.nupkg` file.
95+
96+
```yaml
97+
Type: System.Management.Automation.SwitchParameter
98+
Parameter Sets: (All)
99+
Aliases:
100+
101+
Required: False
102+
Position: Named
103+
Default value: None
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
### -Confirm
109+
110+
Prompts you for confirmation before running the cmdlet.
111+
112+
```yaml
113+
Type: System.Management.Automation.SwitchParameter
114+
Parameter Sets: (All)
115+
Aliases: cf
116+
117+
Required: False
118+
Position: Named
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -WhatIf
125+
126+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
127+
128+
```yaml
129+
Type: System.Management.Automation.SwitchParameter
130+
Parameter Sets: (All)
131+
Aliases: wi
132+
133+
Required: False
134+
Position: Named
135+
Default value: None
136+
Accept pipeline input: False
137+
Accept wildcard characters: False
138+
```
139+
140+
### CommonParameters
141+
142+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
143+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
144+
-WarningAction, and -WarningVariable. For more information, see
145+
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
146+
147+
## INPUTS
148+
149+
### None
150+
151+
## OUTPUTS
152+
153+
### System.String
154+
155+
By default, this command doesn't write any output to the pipeline. When you use the **PassThru**
156+
parameter, it returns full path of the `.nupkg` that was created.
157+
158+
## NOTES
159+
160+
The module defines `cmres` as an alias for `Compress-PSResource`.
161+
162+
This cmdlet allows for publishing nuspec dependencies into ACR.
163+
164+
## RELATED LINKS
165+
166+
[Publish-PSResource](Publish-PSResource.md)

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Find-PSResource.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.0.5
5-
ms.date: 05/17/2024
4+
ms.custom: 1.1.0-preview2
5+
ms.date: 09/16/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/find-psresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
---
@@ -352,7 +352,7 @@ Specifies one or more resource types to find. Resource types supported are:
352352
Type: Microsoft.PowerShell.PSResourceGet.UtilClasses.ResourceType
353353
Parameter Sets: NameParameterSet
354354
Aliases:
355-
Accepted values: None, Module, Script
355+
Accepted values: None, Module, Script, Nupkg
356356
357357
Required: False
358358
Position: Named

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Get-InstalledPSResource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.0.5
5-
ms.date: 05/17/2024
4+
ms.custom: 1.1.0-preview2
5+
ms.date: 09/16/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/get-installedpsresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
---

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Get-PSResourceRepository.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.0.5
5-
ms.date: 05/17/2024
4+
ms.custom: 1.1.0-preview2
5+
ms.date: 09/16/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/get-psresourcerepository?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
---

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Get-PSScriptFileInfo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.0.5
5-
ms.date: 05/17/2024
4+
ms.custom: 1.1.0-preview2
5+
ms.date: 09/16/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/get-psscriptfileinfo?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
---

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Import-PSGetRepository.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.0.5
5-
ms.date: 05/17/2024
4+
ms.custom: 1.1.0-preview2
5+
ms.date: 09/16/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/import-psgetrepository?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
---

powershell-gallery/powershellget-3.x/Microsoft.PowerShell.PSResourceGet/Install-PSResource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.0.5
5-
ms.date: 06/07/2024
4+
ms.custom: 1.1.0-preview2
5+
ms.date: 09/16/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/install-psresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
---

0 commit comments

Comments
 (0)