Fix Add-MachinePath to preserve registry value type and unexpanded variables #819
+25
−8
Conversation
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
…riables Refactor Add-MachinePath to avoid unintended modifications to the PATH registry value: - Use GetValue() with DoNotExpandEnvironmentNames to preserve unexpanded environment variables (e.g., %SystemRoot%) - Preserve original registry value type (REG_SZ vs REG_EXPAND_SZ) using GetValueKind() - Keep original PATH entry values unchanged; normalization (expansion + backslash trimming) only used for duplicate detection - Improve ShouldProcess implementation with proper message/prompt/description parameters for better -WhatIf/-Confirm support - Enhance duplicate detection to compare expanded values, catching duplicates like C:\Windows\System32 vs %SystemRoot%\System32
Author
|
@microsoft-github-policy-service agree |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the Add-MachinePath function to properly preserve the PATH registry value type and unexpanded environment variables when adding new paths to the machine PATH.
Key Changes:
- Uses
GetValue()withDoNotExpandEnvironmentNamesflag to preserve unexpanded variables (e.g.,%SystemRoot%) - Preserves the original registry value type (
REG_SZvsREG_EXPAND_SZ) when updating PATH - Implements path normalization (expansion + backslash trimming) for duplicate detection without modifying original entries
- Adds proper
ShouldProcesssupport for-WhatIfand-Confirmfunctionality
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR Summary
Fix
Add-MachinePathfunction to preserve PATH registry value type and unexpanded environment variables when adding new paths.PR Context
Existing implementation has several issues:
%SystemRoot%becomesC:\Windows)REG_SZvsREG_EXPAND_SZ)Changes
GetValue()withDoNotExpandEnvironmentNamesto preserve unexpanded variablesShouldProcessfor-WhatIf/-ConfirmsupportSet-ItemPropertyparameter (see first commit)