Skip to content

Create checksum file for global tools #17056

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
Mar 25, 2022
Merged

Create checksum file for global tools #17056

merged 2 commits into from
Mar 25, 2022

Conversation

adityapatwardhan
Copy link
Member

@adityapatwardhan adityapatwardhan commented Mar 23, 2022 •
edited
Loading

PR Summary

During refactoring of nuget.yml for SBOM changes, creating checksum for global tool packages was missed. This change adds back creation of a checksum file for global tool packages.

PR Context

PR Checklist

@ghost ghost assigned daxian-dbw Mar 23, 2022
@pull-request-quantifier-deprecated
Copy link

This PR has 21 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       : +20 -1
Percentile : 8.4%

Total files changed: 1

Change summary by file extension:
.yml : +20 -1

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.

@adityapatwardhan
Copy link
Member Author

Test build to verify the new checksum file: https://dev.azure.com/mscodehub/PowerShellCore/_build/results?buildId=250887&view=logs&j=b68f2f44-6987-572d-9dbb-1c96660ee23d&t=815f2ee4-ed58-5f9d-3b75-921a3c1e1e34&l=35

@adityapatwardhan
Copy link
Member Author

This change should be backported to 7.0, 7.1 and 7.2. It is being marked accordingly.

PaulHigin
PaulHigin approved these changes Mar 24, 2022
View reviewed changes
Copy link
Contributor

@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

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

LGTM

tools/releaseBuild/azureDevOps/templates/nuget.yml Outdated
@@ -222,9 +222,36 @@ jobs:
Write-Verbose -Verbose -Message $fileContent

Copy-Item -Path "$packagePath\SHA512SUMS" -Destination '$(System.ArtifactsDirectory)\signed\' -verbose
Copy-Item -Path "$packagePath\SHA512SUMS" -Destination '$(System.ArtifactsDirectory)\signed\globaltool\' -verbose
displayName: Generate checksum file
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
displayName: Generate checksum file
displayName: Generate checksum file for packages

Copy link
Member

Choose a reason for hiding this comment

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

@adityapatwardhan Can you please address this comment? I can merge afterwards.

@daxian-dbw daxian-dbw merged commit 23eddc9 into PowerShell:master Mar 25, 2022
@daxian-dbw daxian-dbw added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Mar 25, 2022
@ghost
Copy link

ghost commented Apr 26, 2022

🎉v7.1.7 has been released which incorporates this pull request.:tada:

Handy links:

@ghost
Copy link

ghost commented Apr 26, 2022

🎉v7.2.3 has been released which incorporates this pull request.:tada:

Handy links:

TravisEz13 pushed a commit to TravisEz13/PowerShell that referenced this pull request Apr 28, 2022
@daxian-dbw
Merged PR 19935: Create checksum file for global tools (PowerShell#17056
3d0f7f0 
)

Cherry-picking the checksum change:
PowerShell#17056
@anmenaga anmenaga mentioned this pull request Apr 28, 2022
Merged
22 tasks
TravisEz13 pushed a commit that referenced this pull request Apr 29, 2022
@daxian-dbw
Merged PR 19934: Create checksum file for global tools
44028aa 
Cherry-picking the checksum changes:
1. #15678
1. #17056
@ghost
Copy link

ghost commented May 23, 2022

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

Handy links:

@TravisEz13 TravisEz13 mentioned this pull request May 24, 2022
Merged
@TravisEz13 TravisEz13 mentioned this pull request Jun 7, 2022
Merged
22 tasks
@TravisEz13 TravisEz13 mentioned this pull request Apr 16, 2024
Closed
@TravisEz13 TravisEz13 mentioned this pull request Jul 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TravisEz13 TravisEz13 TravisEz13 approved these changes

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

@anmenaga anmenaga Awaiting requested review from anmenaga

+1 more reviewer

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@daxian-dbw daxian-dbw

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 Extra Small
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@adityapatwardhan @daxian-dbw @TravisEz13 @PaulHigin