ArmPlatformPkg/ArmPlatformPkg.ci.yaml

   1 ## @file
   2 # CI configuration for ArmPlatformPkg
   3 #
   4 # Copyright (c) 2021, Arm Limited. All rights reserved.<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 {
   8     ## options defined .pytool/Plugin/LicenseCheck
   9     "LicenseCheck": {
  10         "IgnoreFiles": []
  11     },
  12
  13     "EccCheck": {
  14         ## Exception sample looks like below:
  15         ## "ExceptionList": [
  16         ##     "<ErrorID>", "<KeyWord>"
  17         ## ]
  18         "ExceptionList": [
  19         ],
  20         ## Both file path and directory path are accepted.
  21         "IgnoreFiles": [
  22             "Scripts/Ds5/"
  23         ]
  24     },
  25
  26     ## options defined .pytool/Plugin/CompilerPlugin
  27     "CompilerPlugin": {
  28         "DscPath": "ArmPlatformPkg.dsc"
  29     },
  30
  31     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  32     "HostUnitTestCompilerPlugin": {
  33         "DscPath": "" # Don't support this test
  34     },
  35
  36     ## options defined .pytool/Plugin/CharEncodingCheck
  37     "CharEncodingCheck": {
  38         "IgnoreFiles": []
  39     },
  40
  41     ## options defined .pytool/Plugin/DependencyCheck
  42     "DependencyCheck": {
  43         "AcceptableDependencies": [
  44             "ArmPlatformPkg/ArmPlatformPkg.dec",
  45             "ArmPkg/ArmPkg.dec",
  46             "EmbeddedPkg/EmbeddedPkg.dec",
  47             "MdeModulePkg/MdeModulePkg.dec",
  48             "MdePkg/MdePkg.dec"
  49         ],
  50         # For host based unit tests
  51         "AcceptableDependencies-HOST_APPLICATION":[
  52             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  53         ],
  54         # For UEFI shell based apps
  55         "AcceptableDependencies-UEFI_APPLICATION":[],
  56         "IgnoreInf": []
  57     },
  58
  59     ## options defined .pytool/Plugin/DscCompleteCheck
  60     "DscCompleteCheck": {
  61         "IgnoreInf": [],
  62         "DscPath": "ArmPlatformPkg.dsc"
  63     },
  64
  65     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  66     "HostUnitTestDscCompleteCheck": {
  67         "IgnoreInf": [""],
  68         "DscPath": "" # Don't support this test
  69     },
  70
  71     ## options defined .pytool/Plugin/GuidCheck
  72     "GuidCheck": {
  73         "IgnoreGuidName": [],
  74         "IgnoreGuidValue": [],
  75         "IgnoreFoldersAndFiles": [],
  76         "IgnoreDuplicates": [],
  77     },
  78
  79     ## options defined .pytool/Plugin/LibraryClassCheck
  80     "LibraryClassCheck": {
  81         "IgnoreHeaderFile": []
  82     },
  83
  84     ## options defined .pytool/Plugin/SpellCheck
  85     "SpellCheck": {
  86         "AuditOnly": True,
  87         "IgnoreFiles": [],           # use gitignore syntax to ignore errors
  88                                      # in matching files
  89         "ExtendWords": [
  90             "hdlcd",
  91             "icdsgir",
  92             "primecells"
  93            ],           # words to extend to the dictionary for this package
  94         "IgnoreStandardPaths": [    # Standard Plugin defined paths that
  95             "*.asm", "*.s"          # should be ignore
  96         ],
  97         "AdditionalIncludePaths": [] # Additional paths to spell check
  98                                      # (wildcards supported)
  99     }
 100 }