X Tutup
Skip to content

Fixing PS 7.4 regression that is breaking DSCv3#20268

Merged
anmenaga merged 1 commit intoPowerShell:masterfrom
anmenaga:dsc_fix
Sep 13, 2023
Merged

Fixing PS 7.4 regression that is breaking DSCv3#20268
anmenaga merged 1 commit intoPowerShell:masterfrom
anmenaga:dsc_fix

Conversation

@anmenaga
Copy link
Copy Markdown

PR Summary

Some constants/resource strings, used by DSCv3, were accidentally removed by these 2 PRs:
#18383
#18154

Adding these back to PS 7.4 to avoid re-release of DSCv3 module.

PR Context

DSC repo issue: PowerShell/DSC#128

PR Checklist

@pull-request-quantifier-deprecated
Copy link
Copy Markdown

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       : +4 -0
Percentile : 1.6%

Total files changed: 2

Change summary by file extension:
.cs : +1 -0
.resx : +3 -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 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.

@anmenaga anmenaga requested review from SteveL-MSFT and daxian-dbw and removed request for SteveL-MSFT September 12, 2023 20:39
Copy link
Copy Markdown
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.

Since these are only used by PSDSC, would it make more sense to make changes in that code to be self-contained rather than reaching into SMA.dll?

@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 Sep 12, 2023
Copy link
Copy Markdown
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.

Discussed with Andrew. Since we still have some DSC code in SMA.dll, it would be simpler for now to put these lines back and remove them along with the remaining DSC code in the future aligned with a new PSDSC 3.0 release

@anmenaga anmenaga merged commit 6d23f72 into PowerShell:master Sep 13, 2023

internal static class Separators
{
internal static readonly char[] Backslash = new char[] { '\\' };
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I wander how and why DSC uses the internal?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BackPort-7.4.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

X Tutup