CryptoPkg/CryptoPkg.ci.yaml

   1 ## @file
   2 # CI configuration for CryptoPkg
   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             # These directories contain auto-generated OpenSSL content
  12             "Library/OpensslLib/X64",
  13             "Library/OpensslLib/X64Gcc"
  14         ]
  15     },
  16     "EccCheck": {
  17         ## Exception sample looks like below:
  18         ## "ExceptionList": [
  19         ##     "<ErrorID>", "<KeyWord>"
  20         ## ]
  21         "ExceptionList": [
  22         ],
  23         ## Both file path and directory path are accepted.
  24         "IgnoreFiles": [
  25             "Library/OpensslLib/openssl",
  26             # The unit testing folder is not to be checked
  27             "Test/UnitTest",
  28             # This has OpenSSL interfaces that aren't UEFI spec compliant
  29             "Library/BaseCryptLib/SysCall/UnitTestHostCrtWrapper.c",
  30             # This has OpenSSL interfaces that aren't UEFI spec compliant
  31             "Library/OpensslLib/rand_pool.c",
  32             # This has OpenSSL interfaces that aren't UEFI spec compliant
  33             "Library/Include/CrtLibSupport.h",
  34             # These directories contain auto-generated OpenSSL content
  35             "Library/OpensslLib/X64",
  36             "Library/OpensslLib/X64Gcc"
  37         ]
  38     },
  39     "CompilerPlugin": {
  40         "DscPath": "CryptoPkg.dsc"
  41     },
  42     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  43     "HostUnitTestCompilerPlugin": {
  44         "DscPath": "Test/CryptoPkgHostUnitTest.dsc"
  45     },
  46     "CharEncodingCheck": {
  47         "IgnoreFiles": []
  48     },
  49     "DependencyCheck": {
  50         "AcceptableDependencies": [
  51             "MdePkg/MdePkg.dec",
  52             "MdeModulePkg/MdeModulePkg.dec",
  53             "CryptoPkg/CryptoPkg.dec",
  54         ],
  55         # For host based unit tests
  56         "AcceptableDependencies-HOST_APPLICATION":[],
  57         # For UEFI shell based apps
  58         "AcceptableDependencies-UEFI_APPLICATION":[],
  59         "IgnoreInf": []
  60     },
  61     "DscCompleteCheck": {
  62         "DscPath": "CryptoPkg.dsc",
  63         "IgnoreInf": [
  64             # These are alternatives to OpensslLib.inf
  65             "CryptoPkg/Library/OpensslLib/OpensslLibX64.inf",
  66             "CryptoPkg/Library/OpensslLib/OpensslLibX64Gcc.inf"
  67         ]
  68     },
  69     "GuidCheck": {
  70         "IgnoreGuidName": [],
  71         "IgnoreGuidValue": [],
  72         "IgnoreFoldersAndFiles": []
  73     },
  74     "LibraryClassCheck": {
  75         "IgnoreHeaderFile": []
  76     },
  77
  78     ## options defined ci/Plugin/SpellCheck
  79     "SpellCheck": {
  80         "skip": True,
  81         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  82         "ExtendWords": [],           # words to extend to the dictionary for this package
  83         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  84         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  85     }
  86 }