Skip to content

Commit cee0044

Browse files
committed
Update docs for 1.1.0-rc1 release
1 parent e00c490 commit cee0044

22 files changed

+151
-34
lines changed

powershell-gallery/docs-conceptual/powershellget/psresourceget-release-notes.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: This article contains release notes for the PSResourceGet module.
3-
ms.date: 01/31/2024
3+
ms.date: 10/22/2024
44
ms.topic: release-notes
55
title: What's new in PSResourceGet?
66
---
@@ -9,12 +9,13 @@ title: What's new in PSResourceGet?
99
This is a summary of changes to the **Microsoft.PowerShell.PSResourceGet** module. For a more
1010
complete list of changes, see the [CHANGELOG][01] in the GitHub repository.
1111

12-
- Current preview: **Microsoft.PowerShell.PSResourceGet** v1.1.0-preview2
12+
- Current preview: **Microsoft.PowerShell.PSResourceGet** v1.1.0-rc1
1313
- Current stable release: **Microsoft.PowerShell.PSResourceGet** v1.0.5
1414

1515
## Release history
1616

17-
- v1.1.0-preview2 - Current preview release - released to the PowerShell Gallery only
17+
- v1.1.0-rc1 - Current preview release - first shipped in PowerShell 7.5.0-rc1
18+
- v1.1.0-preview2 - released to the PowerShell Gallery only
1819
- v1.1.0-preview.1 - Preview release - first shipped in PowerShell 7.5.0-preview.4
1920
- v1.0.5 - first shipped in PowerShell 7.5.0-preview.3
2021
- v1.0.4.1 - first shipped in PowerShell 7.4.2
@@ -26,6 +27,14 @@ complete list of changes, see the [CHANGELOG][01] in the GitHub repository.
2627

2728
## Release notes
2829

30+
### v1.1.0-rc1 - 2024-10-24
31+
32+
- Added Group Policy support for `PSResourceGet`
33+
- Fix package name matching in local repositories
34+
- `Compress-PSResource` `-PassThru` now passes `FileInfo` instead of string
35+
- Add `AcceptLicense` to `Save-PSResource`
36+
- Other minor bug fixes and improvements
37+
2938
### v1.1.0-preview2 - 2024-09-13
3039

3140
- New cmdlet `Compress-PSResource` to create a `.nupkg` package without publishing it to a repository

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
22
description: Describes how to use version 3.x of the PowerShellGet module.
33
Locale: en-US
4-
ms.custom: 1.0.5
5-
ms.date: 05/17/2024
4+
ms.custom: 1.1.0-rc1
5+
ms.date: 10/22/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/about_PSResourceGet?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: about PSResourceGet
99
---
1010
# about_PSResourceGet
1111

1212
## Short description
13-
Describes how to use version 1.1.0-preview2 of the **Microsoft.PowerShell.PSResourceGet**
14-
module.
13+
14+
Describes how to use version 1.1.0-rc1 of the
15+
**Microsoft.PowerShell.PSResourceGet** module.
1516

1617
## Long description
1718

@@ -32,8 +33,7 @@ This version of PowerShellGet focuses on a few key areas:
3233

3334
Previous versions of **PowerShellGet** had separate commands to work with
3435
modules and scripts. In **Microsoft.PowerShell.PSResourceGet**, all packages in
35-
the PowerShell Gallery are defined as **PSResource** objects. This reduces the
36-
number of cmdlets from 26 in version 2.x to 18 in version 0.9.
36+
the PowerShell Gallery are defined as **PSResource** objects.
3737

3838
The following table shows the cmdlets that are available in **PowerShellGet**
3939
v3 and their v2 equivalents.
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
description: Describes the Group Policy settings for PowerShell
3+
Locale: en-US
4+
ms.custom: 1.1.0-rc1
5+
ms.date: 10/22/2024
6+
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_psresourceget_group_policy?view=powershellget-3.x&WT.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: about_PSResourceGet_Group_Policy
9+
---
10+
# about_PSResourceGet_Group_Policy
11+
12+
## Short description
13+
14+
Describes the Group Policy settings for the PSResourceGet module.
15+
16+
## Long description
17+
18+
**Microsoft.PowerShell.PSResourceGet** includes a Group Policy to specify a
19+
list of repositories that can be accessed by the module. All other repositories
20+
are blocked.
21+
22+
Support for Group Policy was added in **Microsoft.PowerShell.PSResourceGet**
23+
v1.1.0-rc1.
24+
25+
The PowerShell Group Policy settings are in the following Group Policy path:
26+
27+
```
28+
User Configuration\
29+
Administrative Templates\
30+
PSResourceGet Repository Policies
31+
```
32+
33+
There is no computer configuration path for these settings.
34+
35+
**Microsoft.PowerShell.PSResourceGet** includes Group Policy templates and an
36+
installation script in module install location.
37+
38+
Group Policy tools use administrative template files (`.admx`, `.adml`) to
39+
populate policy settings in the user interface. This allows administrators to
40+
manage registry-based policy settings. To install the administrative template,
41+
run the `InstallPSResourceGetPolicyDefinitions.ps1` script from an elevated
42+
PowerShell session. The following example shows the location of the script and
43+
template files.
44+
45+
```powershell
46+
$modulePath = Split-Path (Get-Module -Name Microsoft.PowerShell.PSResourceGet).Path
47+
Get-ChildItem -Path $modulePath\*.adm*, $modulePath\*.ps1
48+
```
49+
50+
```Output
51+
Directory: C:\Program Files\PowerShell\Modules\Microsoft.PowerShell.PSResourceGet\1.1.0
52+
53+
Mode LastWriteTime Length Name
54+
---- ------------- ------ ----
55+
-a--- 10/22/2024 3:48 PM 1364 PSResourceRepository.adml
56+
-a--- 10/22/2024 3:48 PM 1839 PSResourceRepository.admx
57+
-a--- 10/22/2024 3:48 PM 2869 InstallPSResourceGetPolicyDefinitions.ps1
58+
```
59+
60+
After installing the templates, you can edit these settings in the Group Policy
61+
Editor (`gpedit.msc`).
62+
63+
## Configure a list of allowed repositories
64+
65+
There is only one setting for the **PSResourceGet Repository Policies** Group
66+
Policy.
67+
68+
1. Open the Group Policy Editor (`gpedit.msc`)
69+
1. Locate the policy under **User configuration** -> **Administrative
70+
Templates** -> **Windows Components** -> **PSResourceGet Repository
71+
Policies**
72+
1. Open the **PSResourceGet Repository Policy** setting
73+
1. Select **Enabled**
74+
1. Select **Show**
75+
1. Add repository in the format:
76+
`Name=PSGallery;Uri=https://www.powershellgallery.com/api/v2`
77+
78+
> [!NOTE] Don't use quote characters around the values. Separate the
79+
> key-value pairs with a semicolon (`;`) only.
80+
81+
You may add as may repositories as you like, each on their own line.
82+
83+
> [!CAUTION]
84+
> If you enable the policy without defining any repositories then no
85+
> repositories are allowed, effectively disabling
86+
> **Microsoft.PowerShell.PSResourceGet** module.
87+
88+
## Determine the affect of Group Policy
89+
90+
Once you have applied the Group Policy setting, the PSResourceGet commands that
91+
communicate with repositories check the policy before attempting to access the
92+
repository. If the a specified repository isn't in the allow list, you receive
93+
and error message similar to:
94+
95+
> Repository 'RepoName' is not allowed by Group Policy.
96+
97+
Adding repositories to the allow list doesn't register them for the user. You
98+
must use add the repositories using the `Register-PSResourceRepository` cmdlet.
99+
The `Register-PSResourceRepository` cmdlet doesn't access the repository at
100+
registration time. You won't receive an error if the repository isn't in the
101+
allow list until you try to access the repository.
102+
103+
You can use the following command to determine the repositories that are
104+
allowed by Group Policy:
105+
106+
```powershell
107+
Get-PSResourceRepository | Where-Object { $_.IsAllowedByPolicy }
108+
```

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

Lines changed: 6 additions & 6 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.1.0-preview2
5-
ms.date: 09/16/2024
4+
ms.custom: 1.1.0-rc1
5+
ms.date: 10/22/2024
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget/compress-psresource?view=powershellget-3.x&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
---
@@ -16,8 +16,8 @@ Compresses a specified folder containing module or script resources into a `.nup
1616
## SYNTAX
1717

1818
```
19-
Compress-PSResource [-Path] <String> [-DestinationPath] <String> [-PassThru] [-SkipModuleManifestValidate]
20-
[-WhatIf] [-Confirm] [<CommonParameters>]
19+
Compress-PSResource [-Path] <String> [-DestinationPath] <String> [-PassThru]
20+
[-SkipModuleManifestValidate] [-WhatIf] [-Confirm] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
@@ -150,10 +150,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
150150

151151
## OUTPUTS
152152

153-
### System.String
153+
### System.IO.FileSystemInfo
154154

155155
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.
156+
parameter, it returns a **FileSystemInfo** object for the new `.nupkg` file.
157157

158158
## NOTES
159159

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.1.0-preview2
4+
ms.custom: 1.1.0-rc1
55
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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.1.0-preview2
4+
ms.custom: 1.1.0-rc1
55
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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.1.0-preview2
4+
ms.custom: 1.1.0-rc1
55
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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.1.0-preview2
4+
ms.custom: 1.1.0-rc1
55
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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.1.0-preview2
4+
ms.custom: 1.1.0-rc1
55
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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.PowerShell.PSResourceGet.dll-Help.xml
33
Module Name: Microsoft.PowerShell.PSResourceGet
4-
ms.custom: 1.1.0-preview2
4+
ms.custom: 1.1.0-rc1
55
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

0 commit comments

Comments
 (0)