Skip to content

1.1.10

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 02 Aug 16:52
1.1.10
1a621b1
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🪲 [Fix]: Correct the public command help and bring PSSemVer onto the current pipeline (#46)

New-PSSemVer and ConvertTo-PSSemVer now carry correct, linkable help, and the repository runs the current Process-PSModule pipeline with the governance and documentation files the PSModule Repository Standard expects. The [PSSemVer] class and the exported commands behave exactly as before.

Fixed: Command help names real commands and links to the documentation

Both commands' examples referenced New-SemVer and ConvertTo-SemVer — commands this module does not export, so anyone copying Get-Help -Examples output got a CommandNotFoundException. Neither command had a .LINK, so Get-Help -Online had nowhere to go. Each now opens with its canonical psmodule.io documentation URL, followed by the SemVer specification.

This also unblocks CI: Process-PSModule v6 enforces PublicHelpLink, and Test-SourceCode failed on all three runners before the fix.

Changed: Process-PSModule refreshed to v6.1.15

The caller workflow was pinned to v5.4.6 and used secrets: inherit. v6.0.0 removed the fixed TEST_* secret inputs in favour of an explicit TestData object, so inheriting every repository secret is no longer needed. PSSemVer has no test secrets, so the caller now passes only APIKey, matching Template-PSModule and PSModule/GitHub.

Changed: Documentation site config moved to Zensical

Process-PSModule v6.1.13 made Build-Site Zensical-only, so .github/mkdocs.yml was dead configuration and the site was being built from framework defaults. It is replaced by the .github/zensical.toml that Template-PSModule ships.

New: Required governance and agent onboarding files

The repository now carries its own CONTRIBUTING.md, SECURITY.md, SUPPORT.md, CODE_OF_CONDUCT.md, AGENTS.md, CLAUDE.md, and .github/pull_request_template.md instead of relying on the organization .github fallback, which agents, linters, and local tooling never read. The README already linked to CONTRIBUTING.md, which did not exist.

Changed: README follows the module start-page standard

Installation uses Install-PSResource instead of the deprecated Install-Module. The exhaustive per-method example list is replaced by a capabilities showcase covering parsing with a prefix and metadata, SemVer precedence, in-place bumping, and pipeline conversion — every snippet was executed against the module before being written down. The page links to the published documentation at psmodule.io/PSSemVer.

Technical Details

  • .github/workflows/Process-PSModule.yml: @205d193 # v5.4.6 -> @688896d # v6.1.15, secrets: inherit -> secrets: APIKey.
  • .github/mkdocs.yml deleted, .github/zensical.toml added.
  • .github/dependabot.yml: github-actions moved to a daily interval with a 7-day cooldown, matching the template default.
  • tests/PSSemVer.Tests.ps1 now declares #Requires -Modules @{ ModuleName = 'Pester'; ModuleVersion = '6.0.0'; MaximumVersion = '6.*' }, so a runner with Pester 5 available can no longer silently run the wrong version. A forced -Verbose write that only added log noise is gone.
  • Governance files are the Template-PSModule copies; AGENTS.md is adapted to describe PSSemVer and to flag that the public class shape is the module API.
  • .gitignore intentionally keeps !.vscode/*.code-snippets, which the template is missing relative to the canonical github/gitignore VS Code template — see PSModule/Template-PSModule#41.
  • Verified before pushing: 66/66 Pester 6 tests pass against a built artifact, and PSScriptAnalyzer is clean over src/ and tests/ with the repo linter settings.

Review findings filed separately

The behaviour review of [PSSemVer] found defects that change the public class contract, so they are not folded into this change.

Related issues
Assets 3
Loading