RedfishPkg/RedfishPkg.ci.yaml

   1 ## @file
   2 # CI configuration for NetworkPkg
   3 #
   4 # (C) Copyright 2021 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             ## For jansson library open source
  41             ## load.c is overrided from open source.
  42             "Library/JsonLib/load.c",
  43             "Library/JsonLib/jansson_config.h",
  44             "Library/JsonLib/jansson_private_config.h",
  45             ##
  46             ## For libredfish open source
  47             ## The files under edk2libredfish are cloned
  48             ## from DMTF open source
  49             "PrivateLibrary/RedfishLib/edk2libredfish/include/redfish.h",
  50             "PrivateLibrary/RedfishLib/edk2libredfish/include/redfishPayload.h",
  51             "PrivateLibrary/RedfishLib/edk2libredfish/include/redfishService.h",
  52             "PrivateLibrary/RedfishLib/edk2libredfish/include/redpath.h",
  53             "PrivateLibrary/RedfishLib/edk2libredfish/src/payload.c",
  54             "PrivateLibrary/RedfishLib/edk2libredfish/src/redpath.c",
  55             "PrivateLibrary/RedfishLib/edk2libredfish/src/service.c"
  56         ]
  57     },
  58     "CompilerPlugin": {
  59         "DscPath": "RedfishPkg.dsc"
  60     },
  61     "CharEncodingCheck": {
  62         "IgnoreFiles": []
  63     },
  64     "DependencyCheck": {
  65         "AcceptableDependencies": [
  66             "MdePkg/MdePkg.dec",
  67             "MdeModulePkg/MdeModulePkg.dec",
  68             "NetworkPkg/NetworkPkg.dec",
  69             "RedfishPkg/RedfishPkg.dec"
  70         ],
  71         # For host based unit tests
  72         "AcceptableDependencies-HOST_APPLICATION":[],
  73         # For UEFI shell based apps
  74         "AcceptableDependencies-UEFI_APPLICATION":[
  75             "ShellPkg/ShellPkg.dec"
  76         ],
  77         "IgnoreInf": []
  78     },
  79     "DscCompleteCheck": {
  80         "DscPath": "RedfishPkg.dsc",
  81         "IgnoreInf": []
  82     },
  83     "GuidCheck": {
  84         "IgnoreGuidName": [],
  85         "IgnoreGuidValue": [],
  86         "IgnoreFoldersAndFiles": []
  87     },
  88     "LibraryClassCheck": {
  89         "IgnoreHeaderFile": []
  90     },
  91
  92     ## options defined ci/Plugin/SpellCheck
  93     "SpellCheck": {
  94         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  95         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  96         "ExtendWords": [],           # words to extend to the dictionary for this package
  97         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  98         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  99     },
 100
 101     "Defines": {
 102         "BLD_*_CONTINUOUS_INTEGRATION": "TRUE",
 103         "BLD_*_REDFISH_ENABLE": "TRUE"
 104     }
 105 }