Skip to content

Generate manifest with latest public version of the packages#16337

Merged
TravisEz13 merged 5 commits intoPowerShell:masterfrom
TravisEz13:gen-manifest-with-latest-public
Nov 1, 2021
Merged

Generate manifest with latest public version of the packages#16337
TravisEz13 merged 5 commits intoPowerShell:masterfrom
TravisEz13:gen-manifest-with-latest-public

Conversation

@TravisEz13
Copy link
Copy Markdown
Member

@TravisEz13 TravisEz13 commented Oct 30, 2021

PR Summary

Generate manifest with latest public version of the packages

PR Context

Without this, we run the risk of something being missing from the notices file because CG component detection doesn't support self-contained applications.

PR Checklist

Comment thread tools/findMissingNotices.ps1 Outdated
Comment thread tools/findMissingNotices.ps1 Outdated
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

This PR has 139 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       : +82 -57
Percentile : 47.8%

Total files changed: 3

Change summary by file extension:
.yml : +2 -2
.json : +48 -48
.ps1 : +32 -7

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 merged commit 64392f3 into PowerShell:master Nov 1, 2021
@TravisEz13 TravisEz13 deleted the gen-manifest-with-latest-public branch November 1, 2021 17:25
@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
…ell#16337)

* Generate manifest with latest public version of the packages

* update cgmanifest

* update the PR title for the notice update

* Fix code factor issue - use catch block for fall back

* removing noisy logging
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 Medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants