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         ],
  19         ## Both file path and directory path are accepted.
  20         "IgnoreFiles": [
  21         ]
  22     },
  23     "CompilerPlugin": {
  24         "DscPath": "ShellPkg.dsc"
  25     },
  26     "CharEncodingCheck": {
  27         "IgnoreFiles": []
  28     },
  29     "DependencyCheck": {
  30         "AcceptableDependencies": [
  31             "MdePkg/MdePkg.dec",
  32             "MdeModulePkg/MdeModulePkg.dec",
  33             "ShellPkg/ShellPkg.dec",
  34             "NetworkPkg/NetworkPkg.dec"
  35         ],
  36         # For host based unit tests
  37         "AcceptableDependencies-HOST_APPLICATION":[],
  38         # For UEFI shell based apps
  39         "AcceptableDependencies-UEFI_APPLICATION":[],
  40         "IgnoreInf": []
  41     },
  42     "DscCompleteCheck": {
  43         "DscPath": "ShellPkg.dsc",
  44         "IgnoreInf": [
  45             "ShellPkg/Application/ShellCTestApp/ShellCTestApp.inf",
  46             "ShellPkg/Application/ShellExecTestApp/SA.inf",
  47             "ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.inf"
  48             ]
  49     },
  50     "GuidCheck": {
  51         "IgnoreGuidName": [],
  52         "IgnoreGuidValue": [],
  53         "IgnoreFoldersAndFiles": [],
  54         "IgnoreDuplicates": [
  55             "Shell=gUefiShellFileGuid", # by design
  56         ]
  57     },
  58     "LibraryClassCheck": {
  59         "IgnoreHeaderFile": []
  60     },
  61
  62     ## options defined ci/Plugin/SpellCheck
  63     "SpellCheck": {
  64         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  65         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  66         "ExtendWords": [],           # words to extend to the dictionary for this package
  67         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  68         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  69     }
  70 }