Skip to content

Commit 0cb73ac

Browse files
sdwheelersdwheeler
authored
Fixes #1378 - link to manifest UI mapping (#4876)
1 parent 6cfe47a commit 0cb73ac

File tree

4 files changed

+54
-39
lines changed

4 files changed

+54
-39
lines changed

‎reference/5.0/PowershellGet/Publish-Module.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
ms.date: 06/28/2019
3-
schema: 2.0.0
4-
locale: en-us
5-
keywords: powershell,cmdlet
2+
external help file: PSModule-help.xml
3+
keywords: powershell,cmdlet
4+
locale: en-us
5+
Module Name: PowerShellGet
6+
ms.date: 10/03/2019
67
online version: https://go.microsoft.com/fwlink/?linkid=821666
7-
external help file: PSGet-help.xml
8-
title: Publish-Module
8+
schema: 2.0.0
9+
title: Publish-Module
910
---
1011

1112
# Publish-Module
@@ -42,12 +43,6 @@ by running `Get-Module -ListAvailable <Name>`. If you specify a minimum version
4243
publish, `Publish-Module` publishes the first module with a version that is greater than or equal to
4344
the minimum version that you have specified.
4445

45-
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
46-
metadata includes the module name, version, description, and author. Although most metadata is taken
47-
from the module manifest, some metadata must be specified in `Publish-Module` parameters, such as
48-
**Tag**, **ReleaseNote**, **IconUri**, **ProjectUri**, and **LicenseUri**, because these parameters
49-
match fields in a NuGet-based gallery.
50-
5146
## EXAMPLES
5247

5348
### Example 1: Publish a module
@@ -171,7 +166,7 @@ Type: String
171166
Parameter Sets: (All)
172167
Aliases:
173168
174-
Required: True
169+
Required: False
175170
Position: Named
176171
Default value: None
177172
Accept pipeline input: False
@@ -307,12 +302,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
307302

308303
## OUTPUTS
309304

305+
### None
306+
307+
`Publish-Module` shows no output if a module is published successfully.
308+
310309
## NOTES
311310

312311
`Publish-Module` runs on PowerShell 3.0 or later releases of PowerShell, on Windows 7 or Windows
313312
2008 R2 and later releases of Windows.
314313

315-
`Publish-Module` shows no output if a module is published successfully.
314+
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
315+
metadata includes the module name, version, description, and author. Most metadata is taken from the
316+
module manifest, but some metadata can be specified in `Publish-Module` parameters, such as **Tag**,
317+
**ReleaseNote**, **IconUri**, **ProjectUri**, and **LicenseUri**. For more information, see
318+
[Package manifest values that impact the PowerShell Gallery UI](/powershell/scripting/gallery/concepts/package-manifest-affecting-ui).
316319

317320
## RELATED LINKS
318321

‎reference/5.1/PowershellGet/Publish-Module.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: PSModule-help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: PowerShellGet
6-
ms.date: 06/28/2019
6+
ms.date: 10/03/2019
77
online version: https://go.microsoft.com/fwlink/?linkid=821666
88
schema: 2.0.0
99
title: Publish-Module
@@ -45,12 +45,6 @@ by running `Get-Module -ListAvailable <Name>`. If you specify a minimum version
4545
publish, `Publish-Module` publishes the first module with a version that is greater than or equal to
4646
the minimum version that you have specified.
4747

48-
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
49-
metadata includes the module name, version, description, and author. Although most metadata is taken
50-
from the module manifest, some metadata must be specified in `Publish-Module` parameters, such as
51-
**Tag**, **ReleaseNote**, **IconUri**, **ProjectUri**, and **LicenseUri**, because these parameters
52-
match fields in a NuGet-based gallery.
53-
5448
## EXAMPLES
5549

5650
### Example 1: Publish a module
@@ -88,7 +82,7 @@ Aliases:
8882

8983
Required: False
9084
Position: Named
91-
Default value: None
85+
Default value: False
9286
Accept pipeline input: False
9387
Accept wildcard characters: False
9488
```
@@ -121,7 +115,7 @@ Aliases:
121115

122116
Required: False
123117
Position: Named
124-
Default value: None
118+
Default value: False
125119
Accept pipeline input: False
126120
Accept wildcard characters: False
127121
```
@@ -359,12 +353,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
359353

360354
## OUTPUTS
361355

356+
### None
357+
358+
`Publish-Module` shows no output if a module is published successfully.
359+
362360
## NOTES
363361

364362
`Publish-Module` runs on PowerShell 3.0 or later releases of PowerShell, on Windows 7 or Windows
365363
2008 R2 and later releases of Windows.
366364

367-
`Publish-Module` shows no output if a module is published successfully.
365+
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
366+
metadata includes the module name, version, description, and author. Most metadata is taken from the
367+
module manifest, but some metadata can be specified in `Publish-Module` parameters, such as **Tag**,
368+
**ReleaseNote**, **IconUri**, **ProjectUri**, and **LicenseUri**. For more information, see
369+
[Package manifest values that impact the PowerShell Gallery UI](/powershell/scripting/gallery/concepts/package-manifest-affecting-ui).
368370

369371
## RELATED LINKS
370372

‎reference/6/PowerShellGet/Publish-Module.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ external help file: PSModule-help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: PowerShellGet
6-
ms.date: 06/28/2019
7-
online version: https://go.microsoft.com/fwlink/?linkid=2096558
6+
ms.date: 10/03/2019
7+
online version: https://go.microsoft.com/fwlink/?linkid=821666
88
schema: 2.0.0
99
title: Publish-Module
1010
---
@@ -45,12 +45,6 @@ by running `Get-Module -ListAvailable <Name>`. If you specify a minimum version
4545
publish, `Publish-Module` publishes the first module with a version that is greater than or equal to
4646
the minimum version that you have specified.
4747

48-
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
49-
metadata includes the module name, version, description, and author. Although most metadata is taken
50-
from the module manifest, some metadata must be specified in `Publish-Module` parameters, such as
51-
**Tag**, **ReleaseNote**, **IconUri**, **ProjectUri**, and **LicenseUri**, because these parameters
52-
match fields in a NuGet-based gallery.
53-
5448
## EXAMPLES
5549

5650
### Example 1: Publish a module
@@ -88,7 +82,7 @@ Aliases:
8882

8983
Required: False
9084
Position: Named
91-
Default value: None
85+
Default value: False
9286
Accept pipeline input: False
9387
Accept wildcard characters: False
9488
```
@@ -121,7 +115,7 @@ Aliases:
121115

122116
Required: False
123117
Position: Named
124-
Default value: None
118+
Default value: False
125119
Accept pipeline input: False
126120
Accept wildcard characters: False
127121
```
@@ -359,12 +353,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
359353

360354
## OUTPUTS
361355

356+
### None
357+
358+
`Publish-Module` shows no output if a module is published successfully.
359+
362360
## NOTES
363361

364362
`Publish-Module` runs on PowerShell 3.0 or later releases of PowerShell, on Windows 7 or Windows
365363
2008 R2 and later releases of Windows.
366364

367-
`Publish-Module` shows no output if a module is published successfully.
365+
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
366+
metadata includes the module name, version, description, and author. Most metadata is taken from the
367+
module manifest, but some metadata can be specified in `Publish-Module` parameters, such as **Tag**,
368+
**ReleaseNote**, **IconUri**, **ProjectUri**, and **LicenseUri**. For more information, see
369+
[Package manifest values that impact the PowerShell Gallery UI](/powershell/scripting/gallery/concepts/package-manifest-affecting-ui).
368370

369371
## RELATED LINKS
370372

‎reference/7/PowerShellGet/Publish-Module.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: PSModule-help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: PowerShellGet
6-
ms.date: 06/28/2019
6+
ms.date: 10/03/2019
77
online version: https://go.microsoft.com/fwlink/?linkid=2096634
88
schema: 2.0.0
99
title: Publish-Module
@@ -89,7 +89,7 @@ Aliases:
8989

9090
Required: False
9191
Position: Named
92-
Default value: None
92+
Default value: False
9393
Accept pipeline input: False
9494
Accept wildcard characters: False
9595
```
@@ -122,7 +122,7 @@ Aliases:
122122

123123
Required: False
124124
Position: Named
125-
Default value: None
125+
Default value: False
126126
Accept pipeline input: False
127127
Accept wildcard characters: False
128128
```
@@ -377,12 +377,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
377377

378378
## OUTPUTS
379379

380+
### None
381+
382+
`Publish-Module` shows no output if a module is published successfully.
383+
380384
## NOTES
381385

382386
`Publish-Module` runs on PowerShell 3.0 or later releases of PowerShell, on Windows 7 or Windows
383387
2008 R2 and later releases of Windows.
384388

385-
`Publish-Module` shows no output if a module is published successfully.
389+
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
390+
metadata includes the module name, version, description, and author. Most metadata is taken from the
391+
module manifest, but some metadata can be specified in `Publish-Module` parameters, such as **Tag**,
392+
**ReleaseNote**, **IconUri**, **ProjectUri**, and **LicenseUri**. For more information, see
393+
[Package manifest values that impact the PowerShell Gallery UI](/powershell/scripting/gallery/concepts/package-manifest-affecting-ui).
386394

387395
## RELATED LINKS
388396

0 commit comments

Comments
 (0)