Skip to content
Open
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
6 changes: 3 additions & 3 deletions .github/actions/Cleanup-PSModulePrereleases/action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Cleanup-PSModulePrereleases
description: Cleanup prerelease GitHub releases associated with the current pull request branch.
description: Delete prerelease GitHub releases associated with the current pull request branch.
author: PSModule

inputs:
Expand All @@ -16,11 +16,11 @@ inputs:
required: false
default: ''
WhatIf:
description: If specified, the action will only log the changes it would make.
description: If specified, the action only logs the changes it would make.
required: false
default: 'false'
WorkingDirectory:
description: The working directory where the script will run from.
description: Working directory for the script.
required: false
default: '.'

Expand Down
18 changes: 10 additions & 8 deletions .github/actions/Get-PSModuleSettings/action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Get-PSModuleSettings
description: Get settings for a PowerShell module workflow
description: Get settings for a PowerShell module workflow.
author: PSModule
branding:
icon: settings
Expand All @@ -10,7 +10,7 @@ inputs:
description: Name of the module.
required: false
SettingsPath:
description: Path to the settings file (json, yaml/yml, or psd1)
description: Path to the settings file (json, yaml/yml, or psd1).
required: false
Debug:
description: Enable debug output.
Expand All @@ -21,29 +21,31 @@ inputs:
required: false
default: 'false'
Version:
description: Specifies the version of the GitHub module to be installed. Accepts an exact version or a NuGet version range (for example '[1.2.0, 2.0.0)').
description: Version of the GitHub module to install. The action accepts an exact version or a NuGet version range (for example '[1.2.0, 2.0.0)').
required: false
Prerelease:
description: Allow prerelease versions if available.
required: false
default: 'false'
WorkingDirectory:
description: The working directory where the script will run from.
description: Working directory for the script.
required: false
default: ${{ github.workspace }}
ImportantFilePatterns:
description: |
Newline-separated list of regex patterns that identify important files.
Changes matching these patterns trigger build, test, and publish stages.
When set, fully replaces the defaults.
Newline-separated list of regular expression patterns that identify
important files.
Changes that match these patterns trigger build, test, and publish
stages.
When set, the list fully replaces the defaults.
required: false
default: |
^src/
^README\.md$

outputs:
Settings:
description: The complete settings object as JSON, including test suites
description: The complete settings object as JSON, including test suites.
value: ${{ fromJson(steps.Get-PSModuleSettings.outputs.result).Settings }}

runs:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function Resolve-WorkflowEventRouting {
<#
.SYNOPSIS
Resolves release and execution routing from normalized GitHub event state.
Resolve release and execution routing from normalized GitHub event state.
#>
[CmdletBinding()]
[OutputType([PSCustomObject])]
Expand Down Expand Up @@ -82,7 +82,7 @@ function Resolve-WorkflowEventRouting {
function Select-PullRequestForPush {
<#
.SYNOPSIS
Selects the merged default-branch pull request associated with a pushed commit.
Select the merged default-branch pull request associated with a pushed commit.
#>
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '',
Justification = 'Parameter is used inside a Sort-Object script block.')]
Expand Down Expand Up @@ -112,7 +112,7 @@ function Select-PullRequestForPush {
function Get-FilesFromGitTree {
<#
.SYNOPSIS
Returns the files contained in a complete Git tree response.
Return the files from a complete Git tree response.
#>
[CmdletBinding()]
[OutputType([string])]
Expand All @@ -133,7 +133,7 @@ function Get-FilesFromGitTree {
function Get-FilesFromGitHubComparison {
<#
.SYNOPSIS
Returns files from a complete GitHub compare response.
Return files from a complete GitHub compare response.
#>
[CmdletBinding()]
[OutputType([string])]
Expand Down
34 changes: 17 additions & 17 deletions .github/actions/Get-PSModuleSettings/src/Settings.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
},
"ImportantFilePatterns": {
"type": "array",
"description": "Regex patterns that identify important files. Changes matching these patterns trigger build, test, and publish stages. Defaults to ['^src/', '^README\\.md$'] when not configured.",
"description": "Regular expression patterns that identify important files. Changes that match these patterns trigger build, test, and publish stages. When not configured, the defaults are ['^src/', '^README\\.md$'].",
"items": {
"type": "string",
"minLength": 1
}
},
"Test": {
"type": "object",
"description": "Test configuration settings",
"description": "Test configuration",
"properties": {
"Skip": {
"type": "boolean",
Expand Down Expand Up @@ -54,7 +54,7 @@
"properties": {
"Skip": {
"type": "boolean",
"description": "Skip test results collection"
"description": "Skip collection of test results"
}
}
},
Expand All @@ -64,7 +64,7 @@
"properties": {
"Skip": {
"type": "boolean",
"description": "Skip code coverage collection"
"description": "Skip collection of code coverage"
},
"PercentTarget": {
"type": "number",
Expand All @@ -74,15 +74,15 @@
},
"StepSummaryMode": {
"type": "string",
"description": "Mode for displaying step summary"
"description": "Display mode for the step summary"
}
}
}
}
},
"Build": {
"type": "object",
"description": "Build configuration settings",
"description": "Build configuration",
"properties": {
"Skip": {
"type": "boolean",
Expand Down Expand Up @@ -124,7 +124,7 @@
},
"Publish": {
"type": "object",
"description": "Publish configuration settings",
"description": "Publish configuration",
"properties": {
"Module": {
"type": "object",
Expand Down Expand Up @@ -156,35 +156,35 @@
},
"MajorLabels": {
"type": "string",
"description": "Comma-separated labels that trigger major version bump"
"description": "Comma-separated labels that trigger a major version bump"
},
"MinorLabels": {
"type": "string",
"description": "Comma-separated labels that trigger minor version bump"
"description": "Comma-separated labels that trigger a minor version bump"
},
"PatchLabels": {
"type": "string",
"description": "Comma-separated labels that trigger patch version bump"
"description": "Comma-separated labels that trigger a patch version bump"
},
"IgnoreLabels": {
"type": "string",
"description": "Comma-separated labels that prevent release"
"description": "Comma-separated labels that prevent a release"
},
"PrereleaseLabels": {
"type": "string",
"description": "Comma-separated labels that trigger a prerelease"
},
"UsePRTitleAsReleaseName": {
"type": "boolean",
"description": "Use pull request title as the GitHub release name"
"description": "Use the pull request title as the GitHub release name"
},
"UsePRBodyAsReleaseNotes": {
"type": "boolean",
"description": "Use pull request body as the release notes content"
"description": "Use the pull request body as the release notes content"
},
"UsePRTitleAsNotesHeading": {
"type": "boolean",
"description": "Add pull request title as H1 heading in release notes"
"description": "Add the pull request title as an H1 heading in release notes"
},
"ReleaseType": {
"type": "string",
Expand All @@ -203,15 +203,15 @@
"properties": {
"Skip": {
"type": "boolean",
"description": "Skip publishing the generated documentation site"
"description": "Skip publication of the generated documentation site"
}
}
}
}
},
"Linter": {
"type": "object",
"description": "Linter configuration settings",
"description": "Linter configuration",
"properties": {
"Skip": {
"type": "boolean",
Expand Down Expand Up @@ -272,7 +272,7 @@
},
"Run": {
"type": "null",
"description": "Deprecated. Runtime execution flags are now stored on each phase object."
"description": "Deprecated. Runtime execution flags are stored on each phase object."
}
},
"definitions": {
Expand Down
24 changes: 13 additions & 11 deletions .github/actions/Get-PSModuleSettings/src/main.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -528,19 +528,20 @@ if ($settings.Test.Skip) {
function Get-TestItemsFromFolder {
<#
.SYNOPSIS
Retrieves test items from a specified folder.
Get test items from the specified folder.

.DESCRIPTION
This function searches for test-related files in the specified folder.
It looks for configuration files (*.Configuration.ps1), container files (*.Container.ps1),
and test files (*.Tests.ps1) in that order of precedence.
The function searches the specified folder for test-related files.
It searches for configuration files (*.Configuration.ps1), container files (*.Container.ps1),
and test files (*.Tests.ps1), in that order of precedence.

.PARAMETER FolderPath
The path to the folder to search for test items.
Path to the folder to search for test items.

.OUTPUTS
System.IO.FileInfo[]
Returns an array of test-related files found in the folder.

An array of test-related files from the folder.
#>
param ([string]$FolderPath)

Expand All @@ -563,18 +564,19 @@ if ($settings.Test.Skip) {
function Find-TestDirectory {
<#
.SYNOPSIS
Finds test directories recursively.
Find test directories recursively.

.DESCRIPTION
This function recursively searches for all directories starting from the specified path.
It returns a flat array of all directory paths found.
The function searches recursively for all directories from the specified path.
It returns all directory paths in a flat array.

.PARAMETER Path
The root path to start searching for directories.
Root path for the directory search.

.OUTPUTS
System.String[]
Returns an array of directory paths.

An array of directory paths.
#>
param ([string]$Path)

Expand Down
10 changes: 5 additions & 5 deletions .github/actions/Publish-PSModule/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@ inputs:
description: Name of the module to publish.
required: false
ModulePath:
description: Path to the folder containing the <Name>/ module subdirectory from Build-PSModule.
description: Path to the folder with the <Name>/ module subdirectory from Build-PSModule.
required: false
default: .PSModule/module
PSGALLERY_API_KEY:
description: PowerShell Gallery API Key.
description: PowerShell Gallery API key.
required: true
PullRequest:
description: Normalized pull request context JSON from Get-PSModuleSettings.
required: false
default: ''
WhatIf:
description: If specified, the action will only log the changes it would make, but will not publish the module.
description: If specified, the action only logs the changes it would make, but does not publish the module.
required: false
default: 'false'
WorkingDirectory:
description: The working directory where the script will run from.
description: Working directory for the script.
required: false
default: '.'
ArtifactName:
description: Name of the uploaded artifact to download. Must match the name used in the upstream upload-artifact step.
description: Name of the uploaded artifact to download. It must match the name used in the upstream upload-artifact step.
required: false
default: module

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
function Get-ModuleVersionString {
<#
.SYNOPSIS
Builds the SemVer version string that identifies the module itself.
Build the SemVer version string that identifies the module.

.DESCRIPTION
Composes the module version and, when there is one, the prerelease label. This is the string the
PowerShell Gallery and the module manifest understand: `Major.Minor.Patch` optionally followed by
`-<prerelease>`. It never carries the repository's version prefix, because neither the manifest's
`ModuleVersion` nor a Gallery package version accepts one.
If a prerelease label is present, the function puts the module version and the label together.
The PowerShell Gallery and the module manifest use this string: `Major.Minor.Patch` optionally followed by `-<prerelease>`.
The string never includes the repository's version prefix.
Neither the manifest's `ModuleVersion` nor a Gallery package version accepts a prefix.

.OUTPUTS
String with the module version.
System.String

The module version.

.EXAMPLE
Get-ModuleVersionString -ModuleVersion '1.1.10'
Expand Down
14 changes: 7 additions & 7 deletions .github/actions/Release-PSModule/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,31 @@ inputs:
description: Name of the module to release.
required: false
ModulePath:
description: Path to the folder containing the <Name>/ module subdirectory from Build-PSModule.
description: Path to the folder with the <Name>/ module subdirectory from Build-PSModule.
required: false
default: .PSModule/module
ArtifactName:
description: Name of the uploaded artifact to download. Must match the name used in the upstream upload-artifact step.
description: Name of the uploaded artifact to download. It must match the name used in the upstream upload-artifact step.
required: false
default: module
WhatIf:
description: If specified, the action will only log the changes it would make, but will not actually create the release or upload artifacts.
description: If specified, the action only logs the changes it would make, but does not create the release or upload artifacts.
required: false
default: 'false'
WorkingDirectory:
description: The working directory where the script will run from.
description: Working directory for the script.
required: false
default: '.'
UsePRTitleAsReleaseName:
description: When enabled, uses the pull request title as the name for the GitHub release. If not set, the version string is used.
description: When enabled, the action uses the pull request title as the GitHub release name. If not set, it uses the version string.
required: false
default: 'false'
UsePRBodyAsReleaseNotes:
description: When enabled, uses the pull request body as the release notes for the GitHub release. If not set, the release notes are auto-generated.
description: When enabled, the action uses the pull request body as the GitHub release notes. If not set, it auto-generates the release notes.
required: false
default: 'true'
UsePRTitleAsNotesHeading:
description: When enabled along with UsePRBodyAsReleaseNotes, the release notes will begin with the pull request title as a H1 heading followed by the pull request body. The title will reference the pull request number.
description: When enabled with UsePRBodyAsReleaseNotes, the release notes start with the pull request title as an H1 heading. The pull request body follows the heading. The title references the pull request number.
required: false
default: 'true'
ReleaseTag:
Expand Down
Loading
Loading