X Tutup
The Wayback Machine - https://web.archive.org/web/20221003162726/https://github.com/PowerShell/PowerShell/pull/18189
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

Jump to bottom

Remove XML files for min-size package #18189

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove XML files for min-size package #18189

wants to merge 1 commit into from

Conversation

daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Sep 29, 2022

PR Summary

Remove XML files for min-size package.
The min-size package is supposed to:

  1. avoid R2R images for PowerShell and all other library assemblies.
  2. not include the Graphical Host and the WPF/WinForm stuff it pulls in.
  3. remove symbol files (.pdb) and XML document files (.xml)

However, not sure since when, the min-size package for Windows started to have XML files. This PR removes the XML files for Windows min-size package.

Test run build: https://dev.azure.com/mscodehub/PowerShellCore/_build/results?buildId=299968&view=results

PR Checklist

@pull-request-quantifier
Copy link

pull-request-quantifier bot commented Sep 29, 2022

This PR has 20 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       : +11 -9
Percentile : 8%

Total files changed: 3

Change summary by file extension:
.psm1 : +8 -9
.yml : +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? 👍  👌  👎 (Email)
Customize PullRequestQuantifier for this repository.

@daxian-dbw daxian-dbw added CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Backport-7.2.x-Consider Backport-7.3.x-Consider labels Sep 29, 2022
daxian-dbw
daxian-dbw commented Sep 29, 2022
View changes
build.psm1
@@ -1602,14 +1602,14 @@ function Show-PSPesterError
$description = $testFailure.description
$name = $testFailure.name
$message = $testFailure.failure.message
$StackTrace = $testFailure.failure."stack-trace"
$stack_trace = $testFailure.failure."stack-trace"
Copy link
Member Author

@daxian-dbw daxian-dbw Sep 29, 2022

Choose a reason for hiding this comment

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

This is to fix a warning from PSSA -- $StackTrace is a built-in variable, so should use a different name.

build.psm1
@@ -2846,7 +2846,6 @@ assembly
# only create an assembly group if we have tests
if ( $tCases.count -eq 0 -and ! $includeEmpty ) { continue }
$tGroup = $tCases | Group-Object result
$total = $tCases.Count
Copy link
Member Author

@daxian-dbw daxian-dbw Sep 29, 2022

Choose a reason for hiding this comment

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

Also for fixing a PSSA warning -- not used variable.

tools/packaging/packaging.psm1
@@ -4600,14 +4599,14 @@ function Invoke-AzDevOpsLinuxPackageBuild {
# Remove symbol files.
Remove-Item "${buildFolder}\*.pdb" -Force
} elseif ($BuildType -eq 'rpm') {
## Build 'min-size'
## Build for Mariner
Copy link
Member Author

@daxian-dbw daxian-dbw Sep 29, 2022

Choose a reason for hiding this comment

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

This block is for building mariner package, not min-size.

@iSazonov
Copy link
Collaborator

iSazonov commented Sep 30, 2022 •
edited

Perhaps it makes sense to remove resource dll-s too - we have many subfolders with them.
dotnet/sdk#774 (comment)

@daxian-dbw
Copy link
Member Author

daxian-dbw commented Sep 30, 2022

I think it's up to the user of the min-size package to further prune the files based on their scenario. For example, you may want to leave the ru folder around and delete the others :).

@daxian-dbw
Copy link
Member Author

daxian-dbw commented Sep 30, 2022

@adityapatwardhan The test build https://dev.azure.com/mscodehub/PowerShellCore/_build/results?buildId=299968&view=results finished successfully. I have check the produced win-x64-gc.zip package, and the XML files are gone.

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

@TravisEz13 TravisEz13

@adityapatwardhan adityapatwardhan

@anmenaga anmenaga

@PaulHigin PaulHigin

At least 1 approving review is required to merge this pull request.

Assignees

@adityapatwardhan adityapatwardhan

Labels
Backport-7.2.x-Consider Backport-7.3.x-Consider 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.

None yet
4 participants
@daxian-dbw @iSazonov @TravisEz13 @adityapatwardhan
X Tutup