10000 Add ConfigurationFile option to syntax frontmatter by sdwheeler · Pull Request #18093 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Add ConfigurationFile option to syntax frontmatter #18093

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
Merged
merged 2 commits into from
Sep 15, 2022
Merged

Add ConfigurationFile option to syntax frontmatter #18093

merged 2 commits into from
Sep 15, 2022

Conversation

sdwheeler
Copy link
Collaborator

PR Summary

Fixes #18092 - Help text for pwsh does not list -ConfigurationFile in the opening syntax for v7.3.

This PR adds the missing option.

PR Context

PR Checklist

@ghost ghost assigned anmenaga Sep 14, 2022
dkaszews
dkaszews reviewed Sep 14, 2022
View reviewed changes
src/Microsoft.PowerShell.ConsoleHost/resources/ManagedEntranceStrings.resx Outdated
Comment on lines 148 to 149
[-ConfigurationName <string>] [-CustomPipeName <string>]
[-ConfigurationName <string>] [-ConfigurationFile <filePath>]
[-CustomPipeName <string>]
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the logic of grouping options on the same line? Just arbitrary saving of space for related ones?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It makes sense to list the configuration options adjacent to each other. They are grouped to reduce the number of lines of output but the line length is limited to 80 columns.

@sdwheeler
Feedback change from Steve
3264318 
Move EncodedCommand to line above
@pull-request-quantifier-deprecated
Copy link

This PR has 4 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       : +2 -2
Percentile : 1.6%

Total files changed: 1

Change summary by file extension:
.resx : +2 -2

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.

iSazonov
iSazonov reviewed Sep 15, 2022
View reviewed changes
src/Microsoft.PowerShell.ConsoleHost/resources/ManagedEntranceStrings.resx
@@ -145,8 +145,8 @@
<value>Usage: pwsh[.exe] [-Login] [[-File] &lt;filePath&gt; [args]]
[-Command { - | &lt;script-block&gt; [-args &lt;arg-array&gt;]
| &lt;string&gt; [&lt;CommandParameters&gt;] } ]
[-ConfigurationName &lt;string&gt;] [-CustomPipeName &lt;string&gt;]
[-EncodedCommand &lt;Base64EncodedCommand&gt;]
[-ConfigurationName &lt;string&gt;] [-ConfigurationFile &lt;filePath&gt;]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Typo? I'd expect ABC order.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We are not consistent on the ABC order elsewhere. I think it is fine as is.

@daxian-dbw daxian-dbw merged commit 625fc25 into PowerShell:master Sep 15, 2022
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned anmenaga Sep 15, 2022
@daxian-dbw daxian-dbw added CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log Backport-7.3.x-Approved and removed Backport-7.3.x-Consider labels Sep 15, 2022
@daxian-dbw
Copy link
Member

/backport to release/v7.3.0-rc.1

@github-actions github-actions bot mentioned this pull request Sep 15, 2022
Merged
1 task
@ghost
Copy link
ghost commented Sep 20, 2022

🎉v7.3.0-preview.8 has been released which incorporates this pull request.:tada:

Handy links:

@ghost ghost mentioned this pull request Sep 20, 2022
Closed
5 tasks
@michaeltlombardi michaeltlombardi mentioned this pull request Sep 21, 2022
Closed
2 tasks
@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
@ghost
Copy link
ghost commented Dec 20, 2022

🎉v7.4.0-preview.1 has been released which incorporates this pull request.:tada:

Handy links:

@sdwheeler sdwheeler deleted the patch-3 branch January 18, 2024 15:14
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

@dkaszews dkaszews dkaszews approved these changes

@daxian-dbw daxian-dbw Awaiting requested review from daxian-dbw

@anmenaga anmenaga Awaiting requested review from anmenaga

Assignees

@daxian-dbw daxian-dbw

Labels
Backport-7.3.x-Done CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log Extra Small
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Help text for pwsh does not list -ConfigurationFile in the opening syntax for v7.3
7 participants
@sdwheeler @daxian-dbw @SteveL-MSFT @iSazonov @dkaszews @anmenaga @adityapatwardhan
0