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             "ArmPkg/ArmPkg.dec",
  50             "MdeModulePkg/MdeModulePkg.dec",
  51             "MdePkg/MdePkg.dec",
  52             "PrmPkg/PrmPkg.dec",
  53             "ShellPkg/ShellPkg.dec",
  54             "UefiCpuPkg/UefiCpuPkg.dec"
  55         ],
  56         # For host based unit tests
  57         "AcceptableDependencies-HOST_APPLICATION":[
  58             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  59         ],
  60         # For UEFI shell based apps
  61         "AcceptableDependencies-UEFI_APPLICATION":[],
  62         "IgnoreInf": []
  63     },
  64
  65     ## options defined .pytool/Plugin/DscCompleteCheck
  66     "DscCompleteCheck": {
  67         "IgnoreInf": [],
  68         "DscPath": "PrmPkg.dsc"
  69     },
  70
  71     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  72     "HostUnitTestDscCompleteCheck": {
  73         "IgnoreInf": [""],
  74         "DscPath": "Test/PrmPkgHostTest.dsc"
  75     },
  76
  77     ## options defined .pytool/Plugin/GuidCheck
  78     "GuidCheck": {
  79         "IgnoreGuidName": [],
  80         "IgnoreGuidValue": [],
  81         "IgnoreFoldersAndFiles": [],
  82         "IgnoreDuplicates": [],
  83     },
  84
  85     ## options defined .pytool/Plugin/LibraryClassCheck
  86     "LibraryClassCheck": {
  87         "IgnoreHeaderFile": []
  88     },
  89
  90     ## options defined .pytool/Plugin/SpellCheck
  91     "SpellCheck": {
  92         "AuditOnly": False,
  93         "IgnoreFiles": [],          # use gitignore syntax to ignore errors
  94                                     # in matching files
  95         "ExtendWords": [            # words to extend to the dictionary for this package
  96           "buffe",                  # note: appears in buffer ascii dump in documentation
  97           "iptor",                  # note: appears in buffer ascii dump in documentation
  98           "keepoptionalheader",
  99           "odule",                  # note: appears in buffer ascii dump in documentation
 100           "oemid",
 101           "prmopreg",
 102           "prmpecofflib",
 103           "prmpkg",
 104           "prmssdtinstall"
 105         ],
 106         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that
 107                                      # should be ignore
 108         "AdditionalIncludePaths": [] # Additional paths to spell check
 109                                      # (wildcards supported)
 110     }
 111 }