MdeModulePkg/MdeModulePkg.ci.yaml

   1 ## @file
   2 # CI configuration for MdeModulePkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 {
   8     ## options defined ci/Plugin/CompilerPlugin
   9     "CompilerPlugin": {
  10         "DscPath": "MdeModulePkg.dsc"
  11     },
  12     ## options defined ci/Plugin/HostUnitTestCompilerPlugin
  13     "HostUnitTestCompilerPlugin": {
  14         "DscPath": "Test/MdeModulePkgHostTest.dsc"
  15     },
  16
  17     ## options defined ci/Plugin/CharEncodingCheck
  18     "CharEncodingCheck": {
  19         "IgnoreFiles": []
  20     },
  21
  22     ## options defined ci/Plugin/DependencyCheck
  23     "DependencyCheck": {
  24         "AcceptableDependencies": [
  25             "MdePkg/MdePkg.dec",
  26             "MdeModulePkg/MdeModulePkg.dec",
  27             "StandaloneMmPkg/StandaloneMmPkg.dec",
  28             "ArmPkg/ArmPkg.dec"  # this should be fixed by promoting an abstraction
  29         ],
  30         # For host based unit tests
  31         "AcceptableDependencies-HOST_APPLICATION":[
  32             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  33         ],
  34         # For UEFI shell based apps
  35         "AcceptableDependencies-UEFI_APPLICATION":[],
  36         "IgnoreInf": []
  37     },
  38
  39     ## options defined ci/Plugin/DscCompleteCheck
  40     "DscCompleteCheck": {
  41         "IgnoreInf": [],
  42         "DscPath": "MdeModulePkg.dsc"
  43     },
  44     ## options defined ci/Plugin/HostUnitTestDscCompleteCheck
  45     "HostUnitTestDscCompleteCheck": {
  46         "IgnoreInf": [""],
  47         "DscPath": "Test/MdeModulePkgHostTest.dsc"
  48     },
  49
  50     ## options defined ci/Plugin/GuidCheck
  51     "GuidCheck": {
  52         "IgnoreGuidName": [],
  53         "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
  54         "IgnoreFoldersAndFiles": [],
  55         "IgnoreDuplicates": [
  56             "gEdkiiFormBrowserExProtocolGuid=gEfiFormBrowserExProtocolGuid",
  57             "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
  58             "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
  59         ]
  60     },
  61
  62     ## options defined ci/Plugin/LibraryClassCheck
  63     "LibraryClassCheck": {
  64         "IgnoreHeaderFile": []
  65     },
  66
  67     ## options defined ci/Plugin/SpellCheck
  68     "SpellCheck": {
  69         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  70         "IgnoreStandardPaths": [     # Standard Plugin defined paths that should be ignore
  71             "*.c", "*.asm", "*.h", "*.nasm", "*.s", "*.asl", "*.inf"
  72         ],
  73         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files
  74             "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
  75         ],
  76         "ExtendWords": [           # words to extend to the dictionary for this package
  77             "LIGHTGRAY",
  78             "DARKGRAY",
  79             "LIGHTBLUE",
  80             "LIGHTGREEN",
  81             "LIGHTCYAN",
  82             "LIGHTRED",
  83             "LIGHTMAGENTA",
  84             "FVMAIN",
  85             "VARCHECKPCD",
  86             "Getxx",
  87             "lzturbo"
  88         ],
  89         "AdditionalIncludePaths": [] # Additional paths to spell check relative to package root (wildcards supported)
  90     }
  91 }