chore: Raise minimum PowerShell version to 5.1 in module manifest#141
Open
tablackburn wants to merge 3 commits into
Open
chore: Raise minimum PowerShell version to 5.1 in module manifest#141tablackburn wants to merge 3 commits into
tablackburn wants to merge 3 commits into
Conversation
- PowerShellVersion '3.0' -> '5.1'; add CompatiblePSEditions Desktop/Core - Add the first migration-guide entry documenting the new platform floor - Record the change in the changelog under Unreleased - Refresh the stale manifest note in repository-specific instructions BREAKING CHANGE: the manifest now blocks import on PowerShell older than 5.1. Supported and CI-tested platforms are Windows PowerShell 5.1 and PowerShell 7.4+. Decision record: #120. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BxrhSpD47TSrS9hEJpDMaH
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BxrhSpD47TSrS9hEJpDMaH
There was a problem hiding this comment.
Pull request overview
This pull request updates the module’s declared PowerShell support contract by raising the manifest minimum engine version and aligning repo documentation to the new platform floor as part of the v1.0.0 roadmap.
Changes:
- Raise
PowerShellVersionto5.1and addCompatiblePSEditions = @('Desktop','Core')in the module manifest. - Add the first real v0.8 → v1.0 migration-guide entry and populate Quick Start with the breaking-change summary.
- Record the breaking change in
CHANGELOG.mdand update repository-specific agent instructions to reflect the new support floor.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| PowerShellBuild/PowerShellBuild.psd1 | Raises minimum engine version to 5.1 and declares Desktop/Core compatibility. |
| docs/migration-v0.8-to-v1.0.md | Documents the breaking change and adds a Quick Start entry plus the first migration entry. |
| CHANGELOG.md | Records the breaking change under Unreleased. |
| instructions/repository-specific.instructions.md | Updates repo instructions to state the new manifest/platform support contract. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…version CI runs Windows PowerShell 5.1 and the runners' current PowerShell 7 release; it does not pin a 7.4 job. Reword the migration guide, changelog, and AIM instructions so 7.4+ reads as the support floor rather than a specifically CI-tested version, per PR review feedback. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BxrhSpD47TSrS9hEJpDMaH
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
PowerShellBuild.psd1:PowerShellVersionraised from'3.0'to'5.1', andCompatiblePSEditions = @('Desktop', 'Core')added (top-level manifest keys realigned to fit the new longest key — no other values changed)docs/migration-v0.8-to-v1.0.md: first real migration entry, documenting the new platform floor (Windows PowerShell 5.1 / PowerShell 7.4+); Quick Start populated; the fictional template comment block removed per the guide's own instructionsCHANGELOG.md: breaking change recorded under Unreleased → Changedinstructions/repository-specific.instructions.md: stale "currently '3.0' — almost certainly wrong" note replaced with the decided valuesNo CI workflow change is needed:
test.ymldelegates to the org-levelModuleCI.yml, which already runs the suite on Windows PowerShell 5.1 (Desktop) and PowerShell 7+ across Linux/Windows/macOS.Related Issue
Phase 1 of #120 — "Audit
PowerShellVersioninPowerShellBuild.psd1" and "AddCompatiblePSEditions". Decision record: #120 (comment)Motivation and Context
The
'3.0'floor was aspirational: the module's dependencies (Pester 5+/6, BuildHelpers, PSDepend) and toolchain (Microsoft.PowerShell.PlatyPS 1.x in Phase 2) require at least 5.1, and a 0.8.0 regression previously proved nothing enforced the declared floor. The manifest now states the contract that is actually tested. Microsoft.PowerShell.PlatyPS 1.x was validated end-to-end on Windows PowerShell 5.1 before locking the decision in (see the decision record).How Has This Been Tested?
./build.ps1 -Task Test -Bootstrap) run locally on PowerShell 7.6 / LinuxModuleCI.ymlworkflow on this PR exercises the real Windows PowerShell 5.1 engine plus PowerShell 7+ on three platformstests/Manifest.tests.ps1Checklist
Breaking Changes
The manifest now blocks
Import-Moduleon PowerShell older than 5.1. Migration entry included in this PR (docs/migration-v0.8-to-v1.0.md).🤖 Generated with Claude Code
https://claude.ai/code/session_01BxrhSpD47TSrS9hEJpDMaH
Generated by Claude Code