Skip to content

Commit d2c9be2

Browse files
🩹 [Patch]: Update synopsis and description in Publish-PSModule function to clarify GitHub Release creation
1 parent 1a20f25 commit d2c9be2

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

‎scripts/helpers/Publish-PSModule.ps1‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
function Publish-PSModule {
22
<#
3-
.SYNOPSIS
4-
Publishes a module to the PowerShell Gallery.
3+
.SYNOPSIS
4+
Publishes a module to the PowerShell Gallery and creates a GitHub Release.
55
6-
.DESCRIPTION
7-
Publishes a module to the PowerShell Gallery.
6+
.DESCRIPTION
7+
Publishes a module to the PowerShell Gallery and creates a GitHub Release.
88
9-
.EXAMPLE
10-
Publish-PSModule -Name 'PSModule.FX' -APIKey $env:PSGALLERY_API_KEY
9+
.EXAMPLE
10+
Publish-PSModule -Name 'PSModule.FX' -APIKey $env:PSGALLERY_API_KEY
1111
#>
1212
[OutputType([void])]
1313
[CmdletBinding()]
@@ -19,6 +19,10 @@
1919
'PSUseDeclaredVarsMoreThanAssignments', '',
2020
Justification = 'LogGroup - Scoping affects the variables line of sight.'
2121
)]
22+
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
23+
'PSAvoidUsingWriteHost', '',
24+
Justification = 'Log outputs to GitHub Actions logs.'
25+
)]
2226
param(
2327
# Name of the module to process.
2428
[Parameter()]

0 commit comments

Comments
 (0)