🚀 [Feature]: Plan job decides version before build so tested artifact equals published artifact by MariusStorhaug · Pull Request #342 · PSModule/Process-PSModule

Marius Storhaug (MariusStorhaug) · 2026-05-22T19:18:40Z

The version a module ships with is now decided in a new Plan job that runs before the module is built. The same artifact then flows through tests and publish without being mutated, so the artifact you tested is the artifact that lands in the PowerShell Gallery and on the GitHub Release.

Fixes Move version calculation to a Plan job (Resolve-PSModuleVersion) so Build and Publish never calculate or mutate versions #326

New: Plan job replaces Get-Settings

Get-Settings.yml is renamed to Plan.yml. The Plan job runs two steps in sequence and exposes everything downstream jobs need:

Get-PSModuleSettings — loads .github/PSModule.yml and emits the resolved Settings JSON.
Resolve-PSModuleVersion — reads settings + PR labels, queries existing releases and the PowerShell Gallery, and emits the next version.

Plan job output: a single Settings JSON. The resolved version is merged into it as Settings.Module.{Version, Prerelease, FullVersion, ReleaseType, CreateRelease}, so every downstream job receives one self-contained object with no separate version outputs.

flowchart LR
  A[Plan<br/>Get-PSModuleSettings + Resolve-PSModuleVersion] --> B[Build-Module<br/>stamps version into manifest]
  B --> C[Test-* / Coverage]
  C --> D[Publish-Module<br/>publishes artifact unchanged]

Changed: Build-Module now stamps the real version

Build-Module.yml reads the version from Settings.Module.Version / Settings.Module.Prerelease and passes them to Build-PSModule. The built manifest contains the version the module will ship with before any test runs. The 999.0.0 placeholder only appears when no version is provided (for example, direct callers that bypass the Plan job).

Changed: Publish-Module no longer calculates or mutates versions

Publish-Module.yml drops every input that used to drive version calculation:

AutoPatching
DatePrereleaseFormat
IgnoreLabels
IncrementalPrerelease
MajorLabels / MinorLabels / PatchLabels
ReleaseType
VersionPrefix

Publish-Module now reads the version straight from the manifest that arrived from Build-Module and pushes it to the PowerShell Gallery as-is. The PR-title / PR-body / heading inputs are unchanged. The job also gains permission to upload release assets so the zipped module can be attached to the GitHub Release.

Fixed: Tested artifact equals published artifact

The placeholder-then-rewrite flow is gone. The bytes tested in Test-Module / Test-ModuleLocal are the same bytes published to the PowerShell Gallery and attached to the GitHub Release.

Technical Details

Plan.yml (renamed from Get-Settings.yml): adds a Resolve-Version step (runs unconditionally — it computes the release decision, including ReleaseType) followed by an Enrich-Settings step that merges the resolved version into Settings.Module.*. Plan exposes a single Settings output on both the job and workflow_call.
workflow.yml: the Get-Settings job is renamed to Plan and every downstream needs: / with: reference is repointed. Downstream jobs consume the single needs.Plan.outputs.Settings object (version available under Settings.Module.*).
Build-Module.yml: reads Settings.Module.Version / Settings.Module.Prerelease and passes them as Version / Prerelease to Build-PSModule, falling back to the 999.0.0 placeholder when a direct caller bypasses Plan and omits Settings.Module.
Publish-Module.yml: removes the seven version-calculation inputs and grants contents: write permission for release-asset uploads.
README.md: replaces the Get-Settings section with a Plan section that documents both steps and the artifact-integrity guarantee, and notes the new release-asset upload.
PSModule/Build-PSModule pinned to @v5.0.0 (SHA 672aaa7a91a379c4c6cd14494d03ab5e87e13c52).
PSModule/Publish-PSModule pinned to @v3.0.0 (SHA 03c0f8b53d0367c85a0f121f98af9b40c817b0e3).

Companion repos

Repo	Change	Link
`PSModule/Resolve-PSModuleVersion`	New action — v1.1.0 released	https://github.com/PSModule/Resolve-PSModuleVersion/releases/tag/v1.1.0
`PSModule/Build-PSModule`	Major — adds `Version` / `Prerelease` inputs — v5.0.0 released	https://github.com/PSModule/Build-PSModule/releases/tag/v5.0.0
`PSModule/Publish-PSModule`	Major / BREAKING — drops version calculation, publishes pre-stamped artifact, uploads module zip to release — v3.0.0 released	https://github.com/PSModule/Publish-PSModule/releases/tag/v3.0.0

Implementation plan progress

Notes

The public input/output contract of workflow.yml is unchanged for external consumers — this is internal wiring.
✨ [Major]: Move version calculation to Plan job and ship the built artifact (#326) #339 covered the same scope and was closed; this PR restarts the work cleanly off the current main.

…step

github-actions · 2026-05-22T19:21:43Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

github-actions · 2026-05-22T19:48:58Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

github-actions · 2026-05-24T09:25:20Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

github-actions · 2026-05-24T10:28:31Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

github-actions · 2026-05-24T22:59:16Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

github-actions · 2026-05-24T23:05:26Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

…rative

…fects

github-actions · 2026-05-25T06:58:19Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

…mentary

github-actions · 2026-05-25T07:04:22Z

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

The reusable workflow declared the gallery secret as APIKEY while every usage, the nested Publish-Module workflow, the test callers, and the README use APIKey. GitHub secret names are case-insensitive so publishing worked, but this removes the inconsistency Copilot flagged.

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

.github/workflows/workflow.yml:8

The workflow_call secret is renamed to APIKEY, but downstream still references secrets.APIKey (e.g. Publish-Module job). This will fail at runtime (secrets.APIKey will be empty/undefined) and also breaks the stated “public input/output contract … unchanged”. Keep the secret name as APIKey (existing contract) or update all references consistently.

  workflow_call:
    secrets:
      APIKey:
        description: The API key for the PowerShell Gallery.
        required: true

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

…0 placeholder

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 8 comments.

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated no new comments.

Module documentation now renders a command group's overview page as that group's **section landing page** — the content shown when the group is selected in the navigation — instead of a separate page nested under it. This is delivered by bumping the `Document-PSModule` action, and the behavior is documented in the repository and module-source structure guidance. - Fixes #371 ## Changed: Group overview pages are the section landing page Bumped `PSModule/Document-PSModule` to v1.0.18 in `Build-Docs.yml`. v1.0.18 publishes a group's overview page as the section index (`/Functions/<Group>/`) rather than a page nested under the group. Authors can name the overview after its folder (`<Category>/<Category>.md`) or provide `<Category>/index.md` directly; either becomes the section landing page. ## Changed: Documentation Documented the behavior in `README.md`: added a bullet under the repository expectations and updated the `Category.md` annotation in the module source-structure tree. ## Technical Details - `.github/workflows/Build-Docs.yml`: `Document-PSModule@fb5d349 # v1.0.17` -> `@349090c # v1.0.18`. - `main` already carries v1.0.17 (install built modules at their real version) from #342; this PR advances the pin to v1.0.18, which delivers the section-index behavior. - The site config already enables `navigation.indexes`, so no `mkdocs.yml` change is required.

Marius Storhaug (MariusStorhaug) added 5 commits May 22, 2026 21:18

Rename Get-Settings workflow to Plan and add Resolve-PSModuleVersion …

12fbf54

…step

Rewire Process-PSModule workflow jobs to use the Plan job

f62e29f

Forward ModuleVersion and ModulePrerelease into Build-PSModule

821cd03

Drop version-calculation inputs from Publish-Module

9461604

Document the Plan job and the release-asset upload guarantee

4072d6e

Marius Storhaug (MariusStorhaug) changed the title ~~WIP: Plan job (#326)~~ 🚀 [Minor]: Plan job decides version before build so tested artifact equals published artifact (#326) May 22, 2026

Marius Storhaug (MariusStorhaug) added the Minor label May 22, 2026

Marius Storhaug (MariusStorhaug) self-assigned this May 22, 2026

github-advanced-security AI found potential problems May 22, 2026

View reviewed changes

Comment thread .github/workflows/Build-Module.yml Fixed

Comment thread .github/workflows/Plan.yml Fixed

Comment thread .github/workflows/Publish-Module.yml Fixed

Document version resolution algorithm in Plan section

7d80faa

Refactor permissions formatting in workflow files for consistency

5dd0c7e

Update Resolve-PSModuleVersion to v1.0.1

0b0b7a3

Update Build-PSModule to v4.1

7385a29

github-advanced-security AI found potential problems May 24, 2026

View reviewed changes

Comment thread .github/workflows/Build-Module.yml Fixed

Fall back to 0.0.0 when no ModuleVersion is resolved

df0f1c4

Marius Storhaug (MariusStorhaug) mentioned this pull request May 25, 2026

Move version calculation to a Plan job (Resolve-PSModuleVersion) so Build and Publish never calculate or mutate versions #326

Closed

53 tasks

Merge version outputs into Settings object; update README to be decla…

87cf094

…rative

github-advanced-security AI found potential problems May 25, 2026

View reviewed changes

Comment thread .github/workflows/Build-Module.yml Fixed

Tighten Plan section: describe only what Plan does, not downstream ef…

19b2789

…fects

Fix Build module description: correct sequence, remove downstream com…

3d17465

…mentary

Marius Storhaug (MariusStorhaug) changed the title ~~🚀 [Minor]: Plan job decides version before build so tested artifact equals published artifact (#326)~~ 🚀 [Feature]: Plan job decides version before build so tested artifact equals published artifact May 26, 2026

Remove VSCode settings file to streamline project configuration

a0ebb46

Copilot started reviewing on behalf of Marius Storhaug (MariusStorhaug) July 9, 2026 10:55 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Comment thread .github/workflows/Build-Module.yml

Comment thread README.md

docs: fix stale ReleaseType output reference in no-release behavior

4a69251

Marius Storhaug (MariusStorhaug) requested a review from Copilot July 9, 2026 11:14

Copilot started reviewing on behalf of Marius Storhaug (MariusStorhaug) July 9, 2026 11:15 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Comment thread .github/workflows/Plan.yml

Comment thread .github/workflows/Plan.yml

Comment thread .github/workflows/Build-Module.yml Outdated

Comment thread .github/workflows/Test-ModuleLocal.yml Outdated

fix: quote -RequiredVersion and align Build-Module fallback to 999.0.…

3b6c935

…0 placeholder

Marius Storhaug (MariusStorhaug) requested a review from Copilot July 9, 2026 11:29

Copilot started reviewing on behalf of Marius Storhaug (MariusStorhaug) July 9, 2026 11:30 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Comment thread README.md

docs: add missing comma in Plan section

dac345c

Marius Storhaug (MariusStorhaug) requested a review from Copilot July 9, 2026 11:35

Copilot started reviewing on behalf of Marius Storhaug (MariusStorhaug) July 9, 2026 11:35 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Comment thread .github/workflows/Publish-Module.yml

Marius Storhaug (MariusStorhaug) requested a review from Copilot July 9, 2026 11:42

Copilot started reviewing on behalf of Marius Storhaug (MariusStorhaug) July 9, 2026 11:44 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Marius Storhaug (MariusStorhaug) requested a review from Copilot July 9, 2026 11:51

Copilot started reviewing on behalf of Marius Storhaug (MariusStorhaug) July 9, 2026 11:52 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Marius Storhaug (MariusStorhaug) requested a review from Copilot July 9, 2026 20:29

Copilot started reviewing on behalf of Marius Storhaug (MariusStorhaug) July 9, 2026 20:29 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 9, 2026 21:03

Marius Storhaug (MariusStorhaug) merged commit 0d7a2f0 into main Jul 9, 2026
72 checks passed

Marius Storhaug (MariusStorhaug) deleted the feat/326-resolve-psmodule-version branch July 9, 2026 21:04

Marius Storhaug (MariusStorhaug) mentioned this pull request Jul 9, 2026

🩹 [Patch]: Render group overview pages as section landing pages #372

Merged

Marius Storhaug (MariusStorhaug) mentioned this pull request Jul 10, 2026

Plan job fails on schedule/workflow_dispatch: Resolve-Version requires a pull_request event (v6.1.0+ regression) #373

Closed

Uh oh!

Conversation

Marius Storhaug (MariusStorhaug) commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New: Plan job replaces Get-Settings

Changed: Build-Module now stamps the real version

Changed: Publish-Module no longer calculates or mutates versions

Fixed: Tested artifact equals published artifact

Technical Details

Companion repos

Implementation plan progress

Notes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 22, 2026

Super-linter summary

Uh oh!

github-actions Bot commented May 22, 2026

Super-linter summary

Uh oh!

github-actions Bot commented May 24, 2026

Super-linter summary

Uh oh!

github-actions Bot commented May 24, 2026

Super-linter summary

Uh oh!

Uh oh!

github-actions Bot commented May 24, 2026

Super-linter summary

Uh oh!

github-actions Bot commented May 24, 2026

Super-linter summary

Uh oh!

Uh oh!

github-actions Bot commented May 25, 2026

Super-linter summary

Uh oh!

github-actions Bot commented May 25, 2026

Super-linter summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Marius Storhaug (MariusStorhaug) commented May 22, 2026 •

edited

Loading