mu_basecore icon indicating copy to clipboard operation
mu_basecore copied to clipboard

Improve log messages for DependencyCheck, UncrustifyCheck, and SpellCheck

Open jorticus-msft opened this issue 3 years ago • 5 comments
trafficstars

Improve CI log output with more actionable messages, and downgraded some errors/warnings that should not be treated as such

jorticus-msft avatar Aug 04 '22 03:08 jorticus-msft

Do you have a link to a pipeline build with these changes in place?

makubacki avatar Aug 04 '22 21:08 makubacki

Scrubbed output from a local build:

PROGRESS - --Running ExamplePkg: Dependency Check Test NO-TARGET --
ERROR - Dependency Check: ExamplePkg/Library/ExampleLib/ExampleLib.inf depends on pkg OtherPkg/OtherPkg.dec but pkg is not listed in AcceptableDependencies
ERROR - --->Test Failed: Dependency Check Test NO-TARGET returned 1
....
WARNING - Uncrustify found 40 files with formatting errors
CRITICAL - Visit the following instructions to learn how to find the detailed formatting errors in Azure DevOps CI: https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-Formatting#how-to-find-uncrustify-formatting-errors-in-continuous-integration-ci
WARNING - --->Test Skipped: in plugin! Uncrustify Coding Standard Test NO-TARGET
ERROR - Overall Build Status: Error
PROGRESS - There were 1 failures out of 12 attempts
SECTION - Summary
ERROR - Error

jorticus-msft avatar Aug 04 '22 21:08 jorticus-msft

Additional output from the spell checker:

PROGRESS - --Running ExamplePkg: Spell Check Test NO-TARGET --
ERROR - SpellCheck found 2 failing words. See CI log for details.
CRITICAL - If these are not errors add this to your ci.yaml file.
"SpellCheck": {
  "ExtendWords": [
    "asdfasdf",
    "qwerqwer"
  ]
}
ERROR - --->Test Failed: Spell Check Test NO-TARGET returned 24

jorticus-msft avatar Aug 04 '22 22:08 jorticus-msft

@spbrogan did you want to look at this?

@jorticus-msft, are you planning any more changes?

makubacki avatar Aug 31 '22 00:08 makubacki

No further changes planned unless Sean has feedback 🙂

jorticus-msft avatar Aug 31 '22 04:08 jorticus-msft

This PR has been automatically marked as stale because it has not had activity in 60 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

github-actions[bot] avatar Dec 18 '22 23:12 github-actions[bot]

@jorticus-msft - Are you ready for this to be merged?

makubacki avatar Dec 19 '22 14:12 makubacki