Skip to content
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.

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

Update SBOM generation #16641

Merged
merged 11 commits into from Dec 17, 2021
Merged

Update SBOM generation #16641

merged 11 commits into from Dec 17, 2021

Conversation

TravisEz13
Copy link
Member

@TravisEz13 TravisEz13 commented Dec 17, 2021

PR Summary

Update SBOM generation

  • Move cgmanifest into tools folder
  • Make cg detectiond a sbom use tools folder for component detection
  • Add package name and version

PR Context

PR Checklist

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 17, 2021
@pull-request-quantifier-deprecated

This PR has 110 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       : +75 -35
Percentile : 42%

Total files changed: 21

Change summary by file extension:
.yaml : +0 -0
.yml : +73 -33
.ps1 : +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 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 marked this pull request as ready for review December 17, 2021 19:07
@TravisEz13 TravisEz13 merged commit a3788b0 into PowerShell:master Dec 17, 2021
@TravisEz13 TravisEz13 deleted the sbom-changes branch December 17, 2021 19:28
TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
@TravisEz13 TravisEz13 added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Feb 24, 2022
@ghost
Copy link

ghost commented Feb 24, 2022

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

Handy links:

daxian-dbw pushed a commit to daxian-dbw/PowerShell that referenced this pull request Mar 9, 2022
# Conflicts:
#	.vsts-ci/misc-analysis/mdSpell.yml
daxian-dbw pushed a commit to daxian-dbw/PowerShell that referenced this pull request Mar 14, 2022
# Conflicts:
#	.vsts-ci/misc-analysis/mdSpell.yml

# Conflicts:
#	.vsts-ci/linux.yml
#	.vsts-ci/mac.yml
#	.vsts-ci/windows.yml
#	prquantifier.yaml
#	tools/cgmanifest.json
#	tools/findMissingNotices.ps1
#	tools/releaseBuild/azureDevOps/templates/compliance/compliance.yml
#	tools/releaseBuild/azureDevOps/templates/compliance/generateNotice.yml
#	tools/releaseBuild/azureDevOps/templates/windows-hosted-build.yml
daxian-dbw pushed a commit to daxian-dbw/PowerShell that referenced this pull request Mar 15, 2022
# Conflicts:
#	.vsts-ci/misc-analysis/mdSpell.yml

# Conflicts:
#	.vsts-ci/linux.yml
#	.vsts-ci/mac.yml
#	.vsts-ci/windows.yml
#	prquantifier.yaml
#	tools/cgmanifest.json
#	tools/findMissingNotices.ps1
#	tools/releaseBuild/azureDevOps/templates/compliance/compliance.yml
#	tools/releaseBuild/azureDevOps/templates/compliance/generateNotice.yml
#	tools/releaseBuild/azureDevOps/templates/windows-hosted-build.yml

# Conflicts:
#	.vsts-ci/linux.yml
@TravisEz13 TravisEz13 mentioned this pull request Jun 7, 2022
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport-7.0.x-Done BackPort-7.1.x-Done Backport to 7.1.x completed Backport-7.2.x-Done 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.

None yet

3 participants