PrmPkg/PrmPkg.ci.yaml

   1 ## @file
   2 # CI configuration for PrmPkg
   3 #
   4 # Copyright (c) Microsoft Corporation<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 {
   8     ## options defined .pytool/Plugin/LicenseCheck
   9     "LicenseCheck": {
  10         "IgnoreFiles": []
  11     },
  12
  13     "EccCheck": {
  14         ## Exception sample looks like below:
  15         ## "ExceptionList": [
  16         ##     "<ErrorID>", "<KeyWord>"
  17         ## ]
  18         "ExceptionList": [
  19           "5001", "PRM_HANDLER_EXPORT",
  20           "8006", "PRM_HANDLER_EXPORT"
  21         ],
  22         ## Both file path and directory path are accepted.
  23         "IgnoreFiles": [
  24           "Library/DxePrmContextBufferLib/UnitTest",
  25           "Library/DxePrmModuleDiscoveryLib/UnitTest",
  26           "Samples",
  27           "Test"
  28         ]
  29     },
  30
  31     ## options defined .pytool/Plugin/CompilerPlugin
  32     "CompilerPlugin": {
  33         "DscPath": "PrmPkg.dsc"
  34     },
  35
  36     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  37     "HostUnitTestCompilerPlugin": {
  38         "DscPath": "Test/PrmPkgHostTest.dsc"
  39     },
  40
  41     ## options defined .pytool/Plugin/CharEncodingCheck
  42     "CharEncodingCheck": {
  43         "IgnoreFiles": []
  44     },
  45
  46     ## options defined .pytool/Plugin/DependencyCheck
  47     "DependencyCheck": {
  48         "AcceptableDependencies": [
  49             "MdeModulePkg/MdeModulePkg.dec",
  50             "MdePkg/MdePkg.dec",
  51             "PrmPkg/PrmPkg.dec",
  52             "ShellPkg/ShellPkg.dec",
  53             "UefiCpuPkg/UefiCpuPkg.dec"
  54         ],
  55         # For host based unit tests
  56         "AcceptableDependencies-HOST_APPLICATION":[
  57             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  58         ],
  59         # For UEFI shell based apps
  60         "AcceptableDependencies-UEFI_APPLICATION":[],
  61         "IgnoreInf": []
  62     },
  63
  64     ## options defined .pytool/Plugin/DscCompleteCheck
  65     "DscCompleteCheck": {
  66         "IgnoreInf": [],
  67         "DscPath": "PrmPkg.dsc"
  68     },
  69
  70     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  71     "HostUnitTestDscCompleteCheck": {
  72         "IgnoreInf": [""],
  73         "DscPath": "Test/PrmPkgHostTest.dsc"
  74     },
  75
  76     ## options defined .pytool/Plugin/GuidCheck
  77     "GuidCheck": {
  78         "IgnoreGuidName": [],
  79         "IgnoreGuidValue": [],
  80         "IgnoreFoldersAndFiles": [],
  81         "IgnoreDuplicates": [],
  82     },
  83
  84     ## options defined .pytool/Plugin/LibraryClassCheck
  85     "LibraryClassCheck": {
  86         "IgnoreHeaderFile": []
  87     },
  88
  89     ## options defined .pytool/Plugin/SpellCheck
  90     "SpellCheck": {
  91         "AuditOnly": False,
  92         "IgnoreFiles": [],          # use gitignore syntax to ignore errors
  93                                     # in matching files
  94         "ExtendWords": [            # words to extend to the dictionary for this package
  95           "buffe",                  # note: appears in buffer ascii dump in documentation
  96           "iptor",                  # note: appears in buffer ascii dump in documentation
  97           "keepoptionalheader",
  98           "odule",                  # note: appears in buffer ascii dump in documentation
  99           "oemid",
 100           "prmopreg",
 101           "prmpecofflib",
 102           "prmpkg",
 103           "prmssdtinstall"
 104         ],
 105         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that
 106                                      # should be ignore
 107         "AdditionalIncludePaths": [] # Additional paths to spell check
 108                                      # (wildcards supported)
 109     }
 110 }