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             ## 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     },
  47     "CompilerPlugin": {
  48         "DscPath": "RedfishPkg.dsc"
  49     },
  50     "CharEncodingCheck": {
  51         "IgnoreFiles": []
  52     },
  53     "DependencyCheck": {
  54         "AcceptableDependencies": [
  55             "MdePkg/MdePkg.dec",
  56             "MdeModulePkg/MdeModulePkg.dec",
  57             "NetworkPkg/NetworkPkg.dec",
  58             "RedfishPkg/RedfishPkg.dec"
  59         ],
  60         # For host based unit tests
  61         "AcceptableDependencies-HOST_APPLICATION":[],
  62         # For UEFI shell based apps
  63         "AcceptableDependencies-UEFI_APPLICATION":[
  64             "ShellPkg/ShellPkg.dec"
  65         ],
  66         "IgnoreInf": []
  67     },
  68     "DscCompleteCheck": {
  69         "DscPath": "RedfishPkg.dsc",
  70         "IgnoreInf": []
  71     },
  72     "GuidCheck": {
  73         "IgnoreGuidName": [],
  74         "IgnoreGuidValue": [],
  75         "IgnoreFoldersAndFiles": []
  76     },
  77     "LibraryClassCheck": {
  78         "IgnoreHeaderFile": []
  79     },
  80
  81     ## options defined ci/Plugin/SpellCheck
  82     "SpellCheck": {
  83         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  84         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  85         "ExtendWords": [],           # words to extend to the dictionary for this package
  86         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  87         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  88     },
  89
  90     "Defines": {
  91         "BLD_*_CONTINUOUS_INTEGRATION": "TRUE",
  92         "BLD_*_REDFISH_ENABLE": "TRUE"
  93     }
  94 }