RedfishPkg/RedfishPkg.ci.yaml

   1 ## @file
   2 # CI configuration for NetworkPkg
   3 #
   4 # (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 {
   8     "LicenseCheck": {
   9         "IgnoreFiles": []
  10     },
  11     "EccCheck": {
  12         ## Exception sample looks like below:
  13         ## "ExceptionList": [
  14         ##     "<ErrorID>", "<KeyWord>"
  15         ## ]
  16         "ExceptionList": [
  17         ],
  18         ## Both file path and directory path are accepted.
  19         "IgnoreFiles": [
  20             ## Below are files incorporated with open source which are
  21             ## not edk2 coding standard compliant.
  22             ##
  23             ## EDK2 CRT library which is not edk2 coding
  24             ## standard compliant.
  25             ## C runtime library for RedfishPkg modules
  26             "PrivateInclude/Crt/sys",
  27             "PrivateInclude/Crt/assert.h",
  28             "PrivateInclude/Crt/errno.h",
  29             "PrivateInclude/Crt/limits.h",
  30             "PrivateInclude/Crt/math.h",
  31             "PrivateInclude/Crt/stdarg.h",
  32             "PrivateInclude/Crt/stddef.h",
  33             "PrivateInclude/Crt/stdio.h",
  34             "PrivateInclude/Crt/stdlib.h",
  35             "PrivateInclude/Crt/string.h",
  36             "PrivateInclude/Crt/time.h",
  37             "PrivateInclude/Library/RedfishCrtLib.h",
  38             "PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c"
  39         ]
  40     },
  41     "CompilerPlugin": {
  42         "DscPath": "RedfishPkg.dsc"
  43     },
  44     "CharEncodingCheck": {
  45         "IgnoreFiles": []
  46     },
  47     "DependencyCheck": {
  48         "AcceptableDependencies": [
  49             "MdePkg/MdePkg.dec",
  50             "MdeModulePkg/MdeModulePkg.dec",
  51             "NetworkPkg/NetworkPkg.dec",
  52             "RedfishPkg/RedfishPkg.dec"
  53         ],
  54         # For host based unit tests
  55         "AcceptableDependencies-HOST_APPLICATION":[],
  56         # For UEFI shell based apps
  57         "AcceptableDependencies-UEFI_APPLICATION":[
  58             "ShellPkg/ShellPkg.dec"
  59         ],
  60         "IgnoreInf": []
  61     },
  62     "DscCompleteCheck": {
  63         "DscPath": "RedfishPkg.dsc",
  64         "IgnoreInf": []
  65     },
  66     "GuidCheck": {
  67         "IgnoreGuidName": [],
  68         "IgnoreGuidValue": [],
  69         "IgnoreFoldersAndFiles": []
  70     },
  71     "LibraryClassCheck": {
  72         "IgnoreHeaderFile": []
  73     },
  74
  75     ## options defined ci/Plugin/SpellCheck
  76     "SpellCheck": {
  77         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  78         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  79         "ExtendWords": [],           # words to extend to the dictionary for this package
  80         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  81         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  82     },
  83
  84     "Defines": {
  85         "BLD_*_CONTINUOUS_INTEGRATION": "TRUE",
  86         "BLD_*_REDFISH_ENABLE": "TRUE"
  87     }
  88 }