Skip to content

Tags: PSModule/Publish-PSModule

Tags

v2.0.3

Toggle v2.0.3's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
📖 [Docs]: Remove unused configuration options from README (#52)

## Description

This pull request updates the `README.md` file to simplify the list of
configurable settings for the action. It removes several less commonly
used settings to streamline the documentation and make it easier to
read.

Documentation cleanup:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L63-L66):
Removed the following settings from the configuration list: `Debug`,
`Verbose`, `Version`, and `Prerelease`. These settings are no longer
included in the documentation to simplify the list and focus on the most
relevant options.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v2.0.2

Toggle v2.0.2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🩹 [Patch]: Remove reliance on `GitHub` (#51)

## Description

This pull request introduces several updates to streamline the
PowerShell module publishing process and enhance logging functionality.
Key changes include replacing `LogGroup` with `Set-GitHubLogGroup` for
improved GitHub-specific logging, simplifying the `action.yml`
configuration, and refining the `Publish-PSModule` script to focus
solely on publishing to the PowerShell Gallery.

### Updates to `action.yml` Configuration:
* Switched from using `GitHub-Script` to running the script directly
with `pwsh` shell, enabling better control over the execution
environment.
(`[[1]](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L86-R87)`,
`[[2]](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L102-R103)`)

### Enhancements to Logging:
* Replaced all instances of `LogGroup` with `Set-GitHubLogGroup` in
`scripts/helpers/Publish-PSModule.ps1` and `scripts/main.ps1` for
improved GitHub-specific structured logging.
(`[[1]](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9L36-R36)`,
`[[2]](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9L62-R73)`,
`[[3]](diffhunk://#diff-dc2e5a659836b1b73abb03421c567f5018c2755677c4a0aa764cb26117b68011L21-R28)`,
and others)

### Refinements to `Publish-PSModule` Script:
* Updated the `.DESCRIPTION` and `.SYNOPSIS` sections to remove
references to GitHub Pages, focusing exclusively on publishing modules
to the PowerShell Gallery.
(`[scripts/helpers/Publish-PSModule.ps1L4-R7](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9L4-R7)`)
* Removed redundant GitHub Pages functionality, simplifying the script
logic.
(`[scripts/helpers/Publish-PSModule.ps1L4-R7](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9L4-R7)`)

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v2.0

Toggle v2.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
📖 [Docs]: Remove unused configuration options from README (#52)

## Description

This pull request updates the `README.md` file to simplify the list of
configurable settings for the action. It removes several less commonly
used settings to streamline the documentation and make it easier to
read.

Documentation cleanup:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L63-L66):
Removed the following settings from the configuration list: `Debug`,
`Verbose`, `Version`, and `Prerelease`. These settings are no longer
included in the documentation to simplify the list and focus on the most
relevant options.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v2

Toggle v2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
📖 [Docs]: Remove unused configuration options from README (#52)

## Description

This pull request updates the `README.md` file to simplify the list of
configurable settings for the action. It removes several less commonly
used settings to streamline the documentation and make it easier to
read.

Documentation cleanup:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L63-L66):
Removed the following settings from the configuration list: `Debug`,
`Verbose`, `Version`, and `Prerelease`. These settings are no longer
included in the documentation to simplify the list and focus on the most
relevant options.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v2.0.1

Toggle v2.0.1's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🩹 [Patch]: Remove initialization step and dependency on `Utilities` (#50

)

## Description

Remove the initialization step and dependency on `Utilities`, the
Install-PSModuleHelpers takes over.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v2.0.0

Toggle v2.0.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🌟 [Major]: Using settings from `Process-PSModule` + common dependenci…

…es (#49)

## Description

This update elevates `Publish-PSModule` to `v2`, refactoring its inputs,
scripts, and workflows for improved modularity, clarity, and security,
and syncs its usage within the `Process‑PSModule` workflow to consume
the new version and centralized settings.

PSModule/Process-PSModule/pulls/150

### Key Updates

- Explicit Inputs & Defaults
Removed the legacy `ConfigurationFile` input in favor of clearly defined
action inputs (including a new `WorkingDirectory` defaulting to `'.'`),
with reordered parameters for consistency, changing its usage to be via
the settings file introduced in Process-PSModule.
- Bug Fix & Logging Enhancements
Fixed the extra “v” prefix in the Gallery comment by sanitizing the
version string, and added comprehensive logging of all inputs at script
start to aid diagnostics.
  - Fixes PSModule/Process-PSModule/issues/82
- Moved helper scripts
Extracted `Convert-VersionSpec` and `Resolve-PSModuleDependency` into
standalone helpers in `Install-PSModuleHelpers`, replaced verbose calls
with `Write-Host`, and strengthened retry/null‑check logic when querying
the PowerShell Gallery.
- Workflow Security & Consistency
Updated test workflows to use the repository workspace path uniformly
and removed the hardcoded `GITHUB_TOKEN` from the Auto‑Release workflow
in favor of `${{ github.token }}`.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [x] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v1.2.4

Toggle v1.2.4's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🩹 [Patch]: Update linter and git configuration (#47)

## Description

This pull request includes updates to the configuration files for
various linters and a minor update to the LICENSE file. The most
important changes include the addition of a new configuration file for
JSCPD, updates to the PowerShell PSScriptAnalyzer settings, and a
modification to the GitHub workflow for super-linter.

Linter configuration updates:

*
[`.github/linters/.jscpd.json`](diffhunk://#diff-557094e283c00b23265c1c75872f41c6b1a524a00f0d99dd68ebd22cb63bfdd6R1-R10):
Added a new configuration file for JSCPD to set the threshold to 0,
specify reporters, and ignore test files.
*
[`.github/linters/.powershell-psscriptanalyzer.psd1`](diffhunk://#diff-aae69c9d6774628ed181eacf53aee0f38eb6c2f53492cf3a5b7f7bdb6ef43b6aL1-L16):
Updated the PSScriptAnalyzer settings to enable specific rules and
configure their parameters, while also excluding certain rules.

GitHub workflow update:

*
[`.github/workflows/Linter.yml`](diffhunk://#diff-482e65806ed9e4a7320f14964764086b91fed4a28d12e4efde1776472e147e79R30):
Disabled JSON Prettier validation in the super-linter GitHub workflow.

Minor update:

*
[`LICENSE`](diffhunk://#diff-c693279643b8cd5d248172d9c22cb7cf4ed163a3c98c8a3f69c2717edd3eacb7L3-R3):
Updated the copyright year from 2024 to 2025.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v1.2

Toggle v1.2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🩹 [Patch]: Update linter and git configuration (#47)

## Description

This pull request includes updates to the configuration files for
various linters and a minor update to the LICENSE file. The most
important changes include the addition of a new configuration file for
JSCPD, updates to the PowerShell PSScriptAnalyzer settings, and a
modification to the GitHub workflow for super-linter.

Linter configuration updates:

*
[`.github/linters/.jscpd.json`](diffhunk://#diff-557094e283c00b23265c1c75872f41c6b1a524a00f0d99dd68ebd22cb63bfdd6R1-R10):
Added a new configuration file for JSCPD to set the threshold to 0,
specify reporters, and ignore test files.
*
[`.github/linters/.powershell-psscriptanalyzer.psd1`](diffhunk://#diff-aae69c9d6774628ed181eacf53aee0f38eb6c2f53492cf3a5b7f7bdb6ef43b6aL1-L16):
Updated the PSScriptAnalyzer settings to enable specific rules and
configure their parameters, while also excluding certain rules.

GitHub workflow update:

*
[`.github/workflows/Linter.yml`](diffhunk://#diff-482e65806ed9e4a7320f14964764086b91fed4a28d12e4efde1776472e147e79R30):
Disabled JSON Prettier validation in the super-linter GitHub workflow.

Minor update:

*
[`LICENSE`](diffhunk://#diff-c693279643b8cd5d248172d9c22cb7cf4ed163a3c98c8a3f69c2717edd3eacb7L3-R3):
Updated the copyright year from 2024 to 2025.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v1

Toggle v1's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🩹 [Patch]: Update linter and git configuration (#47)

## Description

This pull request includes updates to the configuration files for
various linters and a minor update to the LICENSE file. The most
important changes include the addition of a new configuration file for
JSCPD, updates to the PowerShell PSScriptAnalyzer settings, and a
modification to the GitHub workflow for super-linter.

Linter configuration updates:

*
[`.github/linters/.jscpd.json`](diffhunk://#diff-557094e283c00b23265c1c75872f41c6b1a524a00f0d99dd68ebd22cb63bfdd6R1-R10):
Added a new configuration file for JSCPD to set the threshold to 0,
specify reporters, and ignore test files.
*
[`.github/linters/.powershell-psscriptanalyzer.psd1`](diffhunk://#diff-aae69c9d6774628ed181eacf53aee0f38eb6c2f53492cf3a5b7f7bdb6ef43b6aL1-L16):
Updated the PSScriptAnalyzer settings to enable specific rules and
configure their parameters, while also excluding certain rules.

GitHub workflow update:

*
[`.github/workflows/Linter.yml`](diffhunk://#diff-482e65806ed9e4a7320f14964764086b91fed4a28d12e4efde1776472e147e79R30):
Disabled JSON Prettier validation in the super-linter GitHub workflow.

Minor update:

*
[`LICENSE`](diffhunk://#diff-c693279643b8cd5d248172d9c22cb7cf4ed163a3c98c8a3f69c2717edd3eacb7L3-R3):
Updated the copyright year from 2024 to 2025.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

v1.2.3

Toggle v1.2.3's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
🩹 [Patch]: Require `PSSemVer` and improve logging (#44)

## Description

This pull request includes several updates and improvements to the
`Publish-PSModule` function in the
`scripts/helpers/Publish-PSModule.ps1` file. The changes focus on
enhancing logging, error handling, and parameter management for
PowerShell Gallery operations.

Enhancements to logging and error handling:

* Added `Write-Output` statements to log the process of finding modules
and prerelease versions in the PowerShell Gallery.
[[1]](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9R173-R177)
[[2]](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9L263-R275)
* Replaced `Write-Output $_` with `throw $_` to improve error handling
during retries.

Parameter management improvements:

* Introduced a hashtable `$params` to manage parameters for the
`Find-PSResource` cmdlet, improving code readability and
maintainability.

Minor corrections:

* Corrected the casing of `Write-GitHubNotice` from `Write-GithubNotice`
to ensure consistent function naming.
[[1]](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9L335-R347)
[[2]](diffhunk://#diff-780715ac24c6bbe21b54f3d268778136b79f21a62275bbd494dfa857b4ba40d9L376-R388)

Module dependencies:

* Added `PSSemVer` to the list of required modules in the script header.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas