fix: Refactor GetModifiedSettingsContent for PS5 compatibility#2286
Open
ChrisBlankDe wants to merge 4 commits into
Open
fix: Refactor GetModifiedSettingsContent for PS5 compatibility#2286ChrisBlankDe wants to merge 4 commits into
ChrisBlankDe wants to merge 4 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a PowerShell 5 incompatibility in GetModifiedSettingsContent where reordering the $schema property via Select-Object ..., * -ExcludeProperty '$schema' could incorrectly introduce a literal "*": null entry in the resulting settings JSON. It updates the implementation to explicitly select properties in the desired order and documents the fix in the release notes.
Changes:
- Refactors
$schemareordering inGetModifiedSettingsContentto avoidSelect-Object *and be PowerShell 5-safe. - Adds a release note entry referencing issue #2285 and the
"*": nullinvalid JSON symptom.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| RELEASENOTES.md | Documents the fix for issue #2285 in the release notes. |
| Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1 | Updates $schema property reordering logic to avoid PS5 adding a literal "*" property. |
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.
❔What, Why & How
This pull request makes a targeted improvement to the way the
$schemaproperty is handled in theGetModifiedSettingsContentfunction. The change ensures compatibility with PowerShell 5 by explicitly listing properties instead of using a wildcard, which could cause issues in that version.Select-Objectrather than using a wildcard, preventing the literal*property from being added when reordering$schemato the first position in the settings object.Related to issue: #2285
✅ Checklist