Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change how relative paths in Resolve-Path are handled when using the RelativeBasePath parameter #19755

Merged
merged 5 commits into from
Jul 24, 2023
Merged

Change how relative paths in Resolve-Path are handled when using the RelativeBasePath parameter #19755

merged 5 commits into from
Jul 24, 2023

Conversation

MartinGC94
Copy link
Contributor

PR Summary

Changes how the Path and LiteralPath parameters treat relative input when RelativeBasePath is specified. Previously it would resolve the full path, based on the current directory and then use that to create the relative path. See this demonstration:

PS C:\Users\Martin> Resolve-Path -Path '..\Program Files\' -RelativeBasePath C:\Windows
Resolve-Path: Cannot find path 'C:\Users\Program Files\' because it does not exist.

Now it returns the full, or relative path based off the user specified RelativeBasePath:

PS C:\Users\Martin> Resolve-Path -Path '..\Program Files\' -RelativeBasePath C:\Windows

Path
----
C:\Program Files\

PS C:\Users\Martin> Resolve-Path -Path '..\Program Files\' -RelativeBasePath C:\Windows -Relative
..\Program Files

The relative output may not seem very useful since it's just outputting what the user wrote, but it shows its use when using wildcards:

PS C:\Users\Martin> Resolve-Path -Path '..\Program*' -RelativeBasePath C:\Windows -Relative
..\Program Files
..\Program Files (x86)

This is a breaking change from the current behavior (implemented here: #19358 ) but since it hasn't made its way into a full release yet, it should be fine. This also means this PR should be prioritized to get merged before the next GA release.

Regarding the actual implementation, it feels wrong pushing and popping the location but none of the relevant APIs seemed to support arbitrary paths and it seemed like it would be a lot of work to add it. Maybe someone else has a better suggestion but if not, I hope it's not a blocker.

PR Context

PR Checklist

@ghost ghost assigned TravisEz13 Jun 6, 2023
@MartinGC94 MartinGC94 changed the title Adds support for relative paths in Resolve-Path when using the RelativeBasePath parameter Add support for relative paths in Resolve-Path when using the RelativeBasePath parameter Jun 7, 2023
@StevenBucher98 StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label Jun 12, 2023
@MartinGC94 MartinGC94 changed the title Add support for relative paths in Resolve-Path when using the RelativeBasePath parameter Change how relative paths in Resolve-Path are handled when using the RelativeBasePath parameter Jun 15, 2023
@daxian-dbw daxian-dbw added WG-Engine core PowerShell engine, interpreter, and runtime Needs-Triage The issue is new and needs to be triaged by a work group. labels Jun 19, 2023
@SeeminglyScience SeeminglyScience added the CommunityDay-Small A small PR that the PS team has identified to prioritize to review label Jun 26, 2023
@ghost ghost added the Review - Needed The PR is being reviewed label Jul 4, 2023
@ghost
Copy link

ghost commented Jul 4, 2023

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

SteveL-MSFT
SteveL-MSFT requested changes Jul 10, 2023
View reviewed changes
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't immediately think of a way to solve this without push/pop of the location, but I don't think that's a big deal. Agree we can fix this behavior since it was introduced in a preview.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 10, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Jul 10, 2023
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 11, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 17, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 17, 2023
@pull-request-quantifier-deprecated
Copy link

This PR has 118 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Medium
Size       : +80 -38
Percentile : 43.6%

Total files changed: 2

Change summary by file extension:
.cs : +36 -35
.ps1 : +44 -3

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

SteveL-MSFT
SteveL-MSFT approved these changes Jul 24, 2023
View reviewed changes
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@daxian-dbw daxian-dbw merged commit 3f128d6 into PowerShell:master Jul 24, 2023
34 checks passed
@daxian-dbw daxian-dbw added the CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log label Jul 24, 2023
michaeltlombardi added a commit to michaeltlombardi/PowerShell-Docs that referenced this pull request Aug 22, 2023
@michaeltlombardi
(AB#149096) Update RelativeBasePath for Resolve-Path
4fbbc39 
This change updates the example and documentation for the **RelativeBasePath**
parameter of the `Resolve-Path` cmdlet in PowerShell 7.4 to reflect the changes
made in PowerShell/PowerShell#19755 affecting the output for the cmdlet when
using the parameter.

- Fixes AB#149096
@michaeltlombardi michaeltlombardi mentioned this pull request Aug 22, 2023
Merged
4 tasks
sdwheeler pushed a commit to MicrosoftDocs/PowerShell-Docs that referenced this pull request Aug 22, 2023
@michaeltlombardi
(AB#149096) Update RelativeBasePath for Resolve-Path (#10362)
5791e00 
This change updates the example and documentation for the **RelativeBasePath**
parameter of the `Resolve-Path` cmdlet in PowerShell 7.4 to reflect the changes
made in PowerShell/PowerShell#19755 affecting the output for the cmdlet when
using the parameter.

- Fixes AB#149096
@Taojunshen Taojunshen mentioned this pull request Aug 22, 2023
Merged
4 tasks
@MartinGC94 MartinGC94 mentioned this pull request Dec 14, 2023
Closed
5 tasks
VindSkyggen pushed a commit to VindSkyggen/PowerShell that referenced this pull request Dec 26, 2023
@MartinGC94 @VindSkyggen
Change how relative paths in Resolve-Path are handled when using th…
a464bea 
…e `RelativeBasePath` parameter (PowerShell#19755)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iSazonov iSazonov iSazonov left review comments

@SteveL-MSFT SteveL-MSFT SteveL-MSFT approved these changes

@daxian-dbw daxian-dbw Awaiting requested review from daxian-dbw daxian-dbw is a code owner

@adityapatwardhan adityapatwardhan Awaiting requested review from adityapatwardhan adityapatwardhan is a code owner

Assignees

@TravisEz13 TravisEz13

Labels
CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log CommunityDay-Small A small PR that the PS team has identified to prioritize to review Medium Needs-Triage The issue is new and needs to be triaged by a work group. PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed WG-Engine core PowerShell engine, interpreter, and runtime
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@MartinGC94 @SteveL-MSFT @iSazonov @daxian-dbw @TravisEz13 @StevenBucher98 @SeeminglyScience