ShellPkg/ShellPkg.ci.yaml

   1 ## @file
   2 # CI configuration for ShellPkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
   6 # SPDX-License-Identifier: BSD-2-Clause-Patent
   7 ##
   8 {
   9     "LicenseCheck": {
  10         "IgnoreFiles": []
  11     },
  12     "EccCheck": {
  13         ## Exception sample looks like below:
  14         ## "ExceptionList": [
  15         ##     "<ErrorID>", "<KeyWord>"
  16         ## ]
  17         "ExceptionList": [
  18             "8001", "ShellCommandLineParse"
  19         ],
  20         ## Both file path and directory path are accepted.
  21         "IgnoreFiles": [
  22         ]
  23     },
  24     "CompilerPlugin": {
  25         "DscPath": "ShellPkg.dsc"
  26     },
  27     "CharEncodingCheck": {
  28         "IgnoreFiles": []
  29     },
  30     "DependencyCheck": {
  31         "AcceptableDependencies": [
  32             "MdePkg/MdePkg.dec",
  33             "MdeModulePkg/MdeModulePkg.dec",
  34             "ShellPkg/ShellPkg.dec",
  35             "NetworkPkg/NetworkPkg.dec"
  36         ],
  37         # For host based unit tests
  38         "AcceptableDependencies-HOST_APPLICATION":[],
  39         # For UEFI shell based apps
  40         "AcceptableDependencies-UEFI_APPLICATION":[],
  41         "IgnoreInf": []
  42     },
  43     "DscCompleteCheck": {
  44         "DscPath": "ShellPkg.dsc",
  45         "IgnoreInf": [
  46             "ShellPkg/Application/ShellCTestApp/ShellCTestApp.inf",
  47             "ShellPkg/Application/ShellExecTestApp/SA.inf",
  48             "ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.inf"
  49             ]
  50     },
  51     "GuidCheck": {
  52         "IgnoreGuidName": [],
  53         "IgnoreGuidValue": [],
  54         "IgnoreFoldersAndFiles": [],
  55         "IgnoreDuplicates": [
  56             "Shell=gUefiShellFileGuid", # by design
  57         ]
  58     },
  59     "LibraryClassCheck": {
  60         "IgnoreHeaderFile": []
  61     },
  62
  63     ## options defined ci/Plugin/SpellCheck
  64     "SpellCheck": {
  65         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  66         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  67         "ExtendWords": [],           # words to extend to the dictionary for this package
  68         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  69         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  70     }
  71 }