Skip to content

Refactor cgmanifest generator to include all components#16326

Merged
TravisEz13 merged 18 commits intoPowerShell:masterfrom
TravisEz13:make-cgmanifest-full
Oct 29, 2021
Merged

Refactor cgmanifest generator to include all components#16326
TravisEz13 merged 18 commits intoPowerShell:masterfrom
TravisEz13:make-cgmanifest-full

Conversation

@TravisEz13
Copy link
Copy Markdown
Member

@TravisEz13 TravisEz13 commented Oct 29, 2021

PR Summary

Refactor cgmanifest generator to include all components

  • This should allow us to eliminate the iterative part of the process.
  • By generating a full cgmanifest, we can generate the notice in the build and use that notice, then send a PR back to update the notice checked into the repo.

PR Context

PR Checklist

@TravisEz13
Copy link
Copy Markdown
Member Author

TravisEz13 commented Oct 29, 2021

Example of failing run: https://github.com/PowerShell/PowerShell/actions/runs/1397112178

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

Comment thread tools/findMissingNotices.ps1 Outdated
Comment thread .github/workflows/daily.yml Outdated
Comment thread .github/workflows/daily.yml Outdated
Comment thread .github/workflows/daily.yml Outdated
@TravisEz13 TravisEz13 marked this pull request as ready for review October 29, 2021 22:57
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

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


Quantification details

Label      : Extra Large
Size       : +515 -96
Percentile : 87.03%

Total files changed: 7

Change summary by file extension:
.psm1 : +19 -1
.yml : +45 -31
.json : +420 -48
.yaml : +0 -0
.ps1 : +31 -16

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.

@TravisEz13 TravisEz13 changed the title Refactor cgmanifest generator to include all components Refactor cgmanifest generator to include all components Oct 29, 2021
@TravisEz13 TravisEz13 merged commit 727326d into PowerShell:master Oct 29, 2021
@TravisEz13 TravisEz13 deleted the make-cgmanifest-full branch October 29, 2021 23:29
@anmenaga anmenaga added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Dec 13, 2021
@ghost
Copy link
Copy Markdown

ghost commented Dec 16, 2021

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

Handy links:

TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Extra Large MustHave

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants