X Tutup
Skip to content

re-factor ArgumentToPSVersionTransformationAttribute#16797

Closed
JamesWTruher wants to merge 3 commits intoPowerShell:masterfrom
JamesWTruher:psversionattribute01
Closed

re-factor ArgumentToPSVersionTransformationAttribute#16797
JamesWTruher wants to merge 3 commits intoPowerShell:masterfrom
JamesWTruher:psversionattribute01

Conversation

@JamesWTruher
Copy link
Copy Markdown
Collaborator

@JamesWTruher JamesWTruher commented Jan 24, 2022 •
edited
Loading

PR Summary

This attribute is multiply defined in multiple places, this PR re-factor is the code to have only one definition.

PR Context

This should fix the build break when creating nuget packages.
One side effect of this PR is that the cmdlet set-strictmode will support set-strictmode -version off.

PR Checklist

@ghost ghost assigned anmenaga Jan 24, 2022
@JamesWTruher JamesWTruher marked this pull request as ready for review January 25, 2022 19:37
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated bot commented Jan 25, 2022

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

Quantification details 

Label      : Extra Small
Size       : +11 -15
Percentile : 10.4%

Total files changed: 4

Change summary by file extension:
.cs : +9 -15
.psm1 : +2 -0

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 detetcted.
  • 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.

@daxian-dbw
Copy link
Copy Markdown
Member

daxian-dbw commented Jan 25, 2022

I have a concern on supporting -Version off for Set-StrictMode (see #16736). Quoted here:

IMHO, I think off may not be a suitable value for Set-StrictMode -Version. -Version latest means the latest version, but -Version off doesn't seem to make sense that naturally. The parameter -StrictMode in Invoke-Command is different from -Version, and thus -StrictMode off reads much more naturally than -Version off.

@daxian-dbw
Copy link
Copy Markdown
Member

daxian-dbw commented Jan 25, 2022

As for the build break, here is PR to fix that: #16800. (the ValidateVersionAttribute still needs to be added to that list)

@JamesWTruher
Copy link
Copy Markdown
Collaborator Author

JamesWTruher commented Jan 25, 2022 •
edited
Loading

I have a concern on supporting -Version off for Set-StrictMode (see #16736). Quoted here:

IMHO, I think off may not be a suitable value for Set-StrictMode -Version. -Version latest means the latest version, but -Version off doesn't seem to make sense that naturally. The parameter -StrictMode in Invoke-Command is different from -Version, and thus -StrictMode off reads much more naturally than -Version off.

I agree that it is a little unnatural, however I think that is overweighed by not having duplicated code, which I think is more important than a slight unnaturalness in usage. -Strictmode off will still continue to work, there is now just slightly extended behavior.

PaulHigin
PaulHigin suggested changes Jan 25, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

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

Regarding packaging.psm1 changes, these can be removed because there is already a PR to address it (and which can be backported). #16800.

Otherwise changes LGTM.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 25, 2022
@JamesWTruher
Copy link
Copy Markdown
Collaborator Author

JamesWTruher commented Jan 25, 2022

Regarding packaging.psm1 changes, these can be removed because there is already a PR to address it (and which can be backported). #16800.

Otherwise changes LGTM.

If there is a PR to address the build break, then this PR can be rejected. We don't need to do the re-factor

@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 25, 2022
@JamesWTruher
Copy link
Copy Markdown
Collaborator Author

JamesWTruher commented Jan 25, 2022

closing in favor of #16800

@JamesWTruher JamesWTruher deleted the psversionattribute01 branch September 23, 2023 05:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

@adityapatwardhan adityapatwardhan adityapatwardhan approved these changes

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

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

@anmenaga anmenaga Awaiting requested review from anmenaga

+1 more reviewer

@PaulHigin PaulHigin PaulHigin requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

@anmenaga anmenaga

Labels

Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@JamesWTruher @daxian-dbw @SteveL-MSFT @adityapatwardhan @PaulHigin @anmenaga
X Tutup