8000 Move ApiScan to compliance build by TravisEz13 · Pull Request #18191 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Move ApiScan to compliance build #18191

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 GitH 8000 ub”, 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 10 commits into from
Sep 30, 2022
Merged

Move ApiScan to compliance build #18191

merged 10 commits into from
Sep 30, 2022

Conversation

TravisEz13
Copy link
Member
@TravisEz13 TravisEz13 commented Sep 30, 2022 •
edited
Loading

PR Summary

Move APIScan to compliance pipeline

PR Context

This makes running APIScan and the release faster

PR Checklist

@ghost ghost assigned daxian-dbw Sep 30, 2022
@TravisEz13
Add build and APIScan to compliance build
fbdf809
@TravisEz13
dynamically set version
dee6175 
set releaseTagVar default
@TravisEz13
publish logs
9924bc5
@TravisEz13
set to standard verbosity
ba88624 
only update status every 5 minutes
@TravisEz13
add guardian export
f1381a5 
Publish Guardian reports

publish whole artifact folder

update publish

switch to guardian publish task
@TravisEz13
Download symbols
f70ebad
@TravisEz13
Create configuration that doesn't make it ready to run
05d42eb
@TravisEz13 TravisEz13 force-pushed the compliance-apiscan-gh branch from 2c80c8c to 05d42eb Compare September 30, 2022 19:31
@TravisEz13 TravisEz13 marked this pull request as ready for review September 30, 2022 20:00
adityapatwardhan
adityapatwardhan reviewed Sep 30, 2022
View reviewed changes
PowerShell.Common.props
@@ -193,6 +199,8 @@
<!-- Define all OS, CodeCoverage configuration properties -->
<PropertyGroup Condition=" '$(Configuration)' == 'CodeCoverage' ">
Copy link
Member

Choose a reason for hiding this comment

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

Please remove the code coverage configuration

@pull-request-quantifier-deprecated
Copy link

This PR has 138 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       : +117 -21
Percentile : 47.6%

Total files changed: 5

Change summary by file extension:
.props : +9 -2
.psm1 : +3 -3
.yml : +105 -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 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? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@TravisEz13 TravisEz13 merged commit d9d6b7f into PowerShell:master Sep 30, 2022
@TravisEz13 TravisEz13 deleted the compliance-apiscan-gh branch September 30, 2022 21:59
@daxian-dbw daxian-dbw assigned TravisEz13 and unassigned daxian-dbw Sep 30, 2022
@TravisEz13
Copy link
Member Author

/backport to release/v7.3.0-rc.1

@github-actions github-actions bot mentioned this pull request Oct 13, 2022
Merged
1 task
@ghost
Copy link
ghost commented Oct 26, 2022

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

Handy links:

@adityapatwardhan adityapatwardhan added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Dec 20, 2022
@ghost
Copy link
ghost commented Dec 20, 2022

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

Handy links:

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

@adityapatwardhan adityapatwardhan adityapatwardhan approved these changes

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

@anmenaga anmenaga Awaiting requested review from anmenaga

@PaulHigin PaulHigin Awaiting requested review from PaulHigin

Assignees

@TravisEz13 TravisEz13

Labels
Backport-7.3.x-Done CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Medium MustHave
Projects
None yet
Milestone
No milestone
Development

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