[edk2-devel] [Patch v4 11/22] MdeModulePkg: Add YAML file for CI builds

Michael D Kinney posted 22 patches 6 years, 3 months ago
There is a newer version of this series
[edk2-devel] [Patch v4 11/22] MdeModulePkg: Add YAML file for CI builds
Posted by Michael D Kinney 6 years, 3 months ago
Add YAML file to the package directory with the
configuration of the checks to perform during a
CI build.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
---
 MdeModulePkg/MdeModulePkg.ci.yaml | 81 +++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 MdeModulePkg/MdeModulePkg.ci.yaml

diff --git a/MdeModulePkg/MdeModulePkg.ci.yaml b/MdeModulePkg/MdeModulePkg.ci.yaml
new file mode 100644
index 0000000000..6ae58d5379
--- /dev/null
+++ b/MdeModulePkg/MdeModulePkg.ci.yaml
@@ -0,0 +1,81 @@
+##
+# CI configuration for MdeModulePkg
+#
+# Copyright (c) Microsoft Corporation
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+{
+    ## options defined ci/Plugin/CompilerPlugin
+    "CompilerPlugin": {
+        "DscPath": "MdeModulePkg.dsc"
+    },
+
+    ## options defined ci/Plugin/CharEncodingCheck
+    "CharEncodingCheck": {
+        "IgnoreFiles": []
+    },
+
+    ## options defined ci/Plugin/DependencyCheck
+    "DependencyCheck": {
+        "AcceptableDependencies": [
+            "MdePkg/MdePkg.dec",
+            "MdeModulePkg/MdeModulePkg.dec",
+            "StandaloneMmPkg/StandaloneMmPkg.dec",
+            "ArmPkg/ArmPkg.dec"  # this should be fixed by promoting an abstraction
+        ],
+        # For host based unit tests
+        "AcceptableDependencies-HOST_APPLICATION":[],
+        # For UEFI shell based apps
+        "AcceptableDependencies-UEFI_APPLICATION":[],
+        "IgnoreInf": []
+    },
+
+    ## options defined ci/Plugin/DscCompleteCheck
+    "DscCompleteCheck": {
+        "IgnoreInf": [],
+        "DscPath": "MdeModulePkg.dsc"
+    },
+
+    ## options defined ci/Plugin/GuidCheck
+    "GuidCheck": {
+        "IgnoreGuidName": [],
+        "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
+        "IgnoreFoldersAndFiles": [],
+        "IgnoreDuplicates": [
+            "gEdkiiFormBrowserExProtocolGuid=gEfiFormBrowserExProtocolGuid",
+            "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
+            "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
+            "gEdkiiSerialPortLibVendorGuid=SerialDxe"  # Is this a bug????
+        ]
+    },
+
+    ## options defined ci/Plugin/LibraryClassCheck
+    "LibraryClassCheck": {
+        "IgnoreHeaderFile": []
+    },
+
+    ## options defined ci/Plugin/SpellCheck
+    "SpellCheck": {
+        "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
+        "IgnoreStandardPaths": [     # Standard Plugin defined paths that should be ignore
+            "*.c", "*.asm", "*.h", "*.nasm", "*.s", "*.asl", "*.inf"
+        ],
+        "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files
+            "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
+        ],
+        "ExtendWords": [           # words to extend to the dictionary for this package
+            "LIGHTGRAY",
+            "DARKGRAY",
+            "LIGHTBLUE",
+            "LIGHTGREEN",
+            "LIGHTCYAN",
+            "LIGHTRED",
+            "LIGHTMAGENTA",
+            "FVMAIN",
+            "VARCHECKPCD",
+            "Getxx",
+            "lzturbo"
+        ],
+        "AdditionalIncludePaths": [] # Additional paths to spell check relative to package root (wildcards supported)
+    }
+}
-- 
2.21.0.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#50137): https://edk2.groups.io/g/devel/message/50137
Mute This Topic: https://groups.io/mt/44874075/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [Patch v4 11/22] MdeModulePkg: Add YAML file for CI builds
Posted by Wu, Hao A 6 years, 3 months ago
> -----Original Message-----
> From: Kinney, Michael D
> Sent: Thursday, November 07, 2019 9:14 AM
> To: devel@edk2.groups.io
> Cc: Wang, Jian J; Wu, Hao A
> Subject: [Patch v4 11/22] MdeModulePkg: Add YAML file for CI builds
> 
> Add YAML file to the package directory with the
> configuration of the checks to perform during a
> CI build.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> ---
>  MdeModulePkg/MdeModulePkg.ci.yaml | 81
> +++++++++++++++++++++++++++++++
>  1 file changed, 81 insertions(+)
>  create mode 100644 MdeModulePkg/MdeModulePkg.ci.yaml
> 
> diff --git a/MdeModulePkg/MdeModulePkg.ci.yaml
> b/MdeModulePkg/MdeModulePkg.ci.yaml
> new file mode 100644
> index 0000000000..6ae58d5379
> --- /dev/null
> +++ b/MdeModulePkg/MdeModulePkg.ci.yaml
> @@ -0,0 +1,81 @@
> +##
> +# CI configuration for MdeModulePkg
> +#
> +# Copyright (c) Microsoft Corporation
> +# SPDX-License-Identifier: BSD-2-Clause-Patent
> +##
> +{
> +    ## options defined ci/Plugin/CompilerPlugin
> +    "CompilerPlugin": {
> +        "DscPath": "MdeModulePkg.dsc"
> +    },
> +
> +    ## options defined ci/Plugin/CharEncodingCheck
> +    "CharEncodingCheck": {
> +        "IgnoreFiles": []
> +    },
> +
> +    ## options defined ci/Plugin/DependencyCheck
> +    "DependencyCheck": {
> +        "AcceptableDependencies": [
> +            "MdePkg/MdePkg.dec",
> +            "MdeModulePkg/MdeModulePkg.dec",
> +            "StandaloneMmPkg/StandaloneMmPkg.dec",
> +            "ArmPkg/ArmPkg.dec"  # this should be fixed by promoting an
> abstraction
> +        ],
> +        # For host based unit tests
> +        "AcceptableDependencies-HOST_APPLICATION":[],
> +        # For UEFI shell based apps
> +        "AcceptableDependencies-UEFI_APPLICATION":[],
> +        "IgnoreInf": []
> +    },
> +
> +    ## options defined ci/Plugin/DscCompleteCheck
> +    "DscCompleteCheck": {
> +        "IgnoreInf": [],
> +        "DscPath": "MdeModulePkg.dsc"
> +    },
> +
> +    ## options defined ci/Plugin/GuidCheck
> +    "GuidCheck": {
> +        "IgnoreGuidName": [],
> +        "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
> +        "IgnoreFoldersAndFiles": [],
> +        "IgnoreDuplicates": [
> +
> "gEdkiiFormBrowserExProtocolGuid=gEfiFormBrowserExProtocolGuid",
> +            "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
> +            "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
> +            "gEdkiiSerialPortLibVendorGuid=SerialDxe"  # Is this a bug????


Hello Mike,

I think the above GUID duplication (serial-related) has already been addressed
via commits:

SHA-1: 0d85e67714e31e0dbe4241ab2ebb7c423aba174d
* MdeModulePkg/SerialDxe: Update the file Guid in SerialDxe.inf

SHA-1: 9790f62be1aa5ee9460d4c4ec8c720919523bb62
* MdeModulePkg SerialDxe.inf: Fix wrong FILE_GUID format

Could you help to confirm whether the item can be removed?

With it handled,
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu


> +        ]
> +    },
> +
> +    ## options defined ci/Plugin/LibraryClassCheck
> +    "LibraryClassCheck": {
> +        "IgnoreHeaderFile": []
> +    },
> +
> +    ## options defined ci/Plugin/SpellCheck
> +    "SpellCheck": {
> +        "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect
> log
> +        "IgnoreStandardPaths": [     # Standard Plugin defined paths that should
> be ignore
> +            "*.c", "*.asm", "*.h", "*.nasm", "*.s", "*.asl", "*.inf"
> +        ],
> +        "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching
> files
> +            "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
> +        ],
> +        "ExtendWords": [           # words to extend to the dictionary for this
> package
> +            "LIGHTGRAY",
> +            "DARKGRAY",
> +            "LIGHTBLUE",
> +            "LIGHTGREEN",
> +            "LIGHTCYAN",
> +            "LIGHTRED",
> +            "LIGHTMAGENTA",
> +            "FVMAIN",
> +            "VARCHECKPCD",
> +            "Getxx",
> +            "lzturbo"
> +        ],
> +        "AdditionalIncludePaths": [] # Additional paths to spell check relative to
> package root (wildcards supported)
> +    }
> +}
> --
> 2.21.0.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#50157): https://edk2.groups.io/g/devel/message/50157
Mute This Topic: https://groups.io/mt/44874075/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [Patch v4 11/22] MdeModulePkg: Add YAML file for CI builds
Posted by Michael D Kinney 6 years, 3 months ago
Hao Wu,

I agree that this duplicate GUID exception can be removed.

I tried it out with a PR against edk2-staging/edk2-ci and 
it passed all checks.

https://github.com/tianocore/edk2-staging/pull/180

Mike

> -----Original Message-----
> From: Wu, Hao A <hao.a.wu@intel.com>
> Sent: Wednesday, November 6, 2019 7:03 PM
> To: Kinney, Michael D <michael.d.kinney@intel.com>;
> devel@edk2.groups.io
> Cc: Wang, Jian J <jian.j.wang@intel.com>
> Subject: RE: [Patch v4 11/22] MdeModulePkg: Add YAML
> file for CI builds
> 
> > -----Original Message-----
> > From: Kinney, Michael D
> > Sent: Thursday, November 07, 2019 9:14 AM
> > To: devel@edk2.groups.io
> > Cc: Wang, Jian J; Wu, Hao A
> > Subject: [Patch v4 11/22] MdeModulePkg: Add YAML file
> for CI builds
> >
> > Add YAML file to the package directory with the
> configuration of the
> > checks to perform during a CI build.
> >
> > Cc: Jian J Wang <jian.j.wang@intel.com>
> > Cc: Hao A Wu <hao.a.wu@intel.com>
> > Signed-off-by: Michael D Kinney
> <michael.d.kinney@intel.com>
> > ---
> >  MdeModulePkg/MdeModulePkg.ci.yaml | 81
> > +++++++++++++++++++++++++++++++
> >  1 file changed, 81 insertions(+)
> >  create mode 100644 MdeModulePkg/MdeModulePkg.ci.yaml
> >
> > diff --git a/MdeModulePkg/MdeModulePkg.ci.yaml
> > b/MdeModulePkg/MdeModulePkg.ci.yaml
> > new file mode 100644
> > index 0000000000..6ae58d5379
> > --- /dev/null
> > +++ b/MdeModulePkg/MdeModulePkg.ci.yaml
> > @@ -0,0 +1,81 @@
> > +##
> > +# CI configuration for MdeModulePkg
> > +#
> > +# Copyright (c) Microsoft Corporation # SPDX-License-
> Identifier:
> > +BSD-2-Clause-Patent ## {
> > +    ## options defined ci/Plugin/CompilerPlugin
> > +    "CompilerPlugin": {
> > +        "DscPath": "MdeModulePkg.dsc"
> > +    },
> > +
> > +    ## options defined ci/Plugin/CharEncodingCheck
> > +    "CharEncodingCheck": {
> > +        "IgnoreFiles": []
> > +    },
> > +
> > +    ## options defined ci/Plugin/DependencyCheck
> > +    "DependencyCheck": {
> > +        "AcceptableDependencies": [
> > +            "MdePkg/MdePkg.dec",
> > +            "MdeModulePkg/MdeModulePkg.dec",
> > +            "StandaloneMmPkg/StandaloneMmPkg.dec",
> > +            "ArmPkg/ArmPkg.dec"  # this should be
> fixed by promoting
> > + an
> > abstraction
> > +        ],
> > +        # For host based unit tests
> > +        "AcceptableDependencies-HOST_APPLICATION":[],
> > +        # For UEFI shell based apps
> > +        "AcceptableDependencies-UEFI_APPLICATION":[],
> > +        "IgnoreInf": []
> > +    },
> > +
> > +    ## options defined ci/Plugin/DscCompleteCheck
> > +    "DscCompleteCheck": {
> > +        "IgnoreInf": [],
> > +        "DscPath": "MdeModulePkg.dsc"
> > +    },
> > +
> > +    ## options defined ci/Plugin/GuidCheck
> > +    "GuidCheck": {
> > +        "IgnoreGuidName": [],
> > +        "IgnoreGuidValue": ["00000000-0000-0000-0000-
> 000000000000"],
> > +        "IgnoreFoldersAndFiles": [],
> > +        "IgnoreDuplicates": [
> > +
> >
> "gEdkiiFormBrowserExProtocolGuid=gEfiFormBrowserExProtoc
> olGuid",
> > +
> "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
> > +
> "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
> > +            "gEdkiiSerialPortLibVendorGuid=SerialDxe"
> # Is this a bug????
> 
> 
> Hello Mike,
> 
> I think the above GUID duplication (serial-related) has
> already been addressed via commits:
> 
> SHA-1: 0d85e67714e31e0dbe4241ab2ebb7c423aba174d
> * MdeModulePkg/SerialDxe: Update the file Guid in
> SerialDxe.inf
> 
> SHA-1: 9790f62be1aa5ee9460d4c4ec8c720919523bb62
> * MdeModulePkg SerialDxe.inf: Fix wrong FILE_GUID format
> 
> Could you help to confirm whether the item can be
> removed?
> 
> With it handled,
> Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
> 
> Best Regards,
> Hao Wu
> 
> 
> > +        ]
> > +    },
> > +
> > +    ## options defined ci/Plugin/LibraryClassCheck
> > +    "LibraryClassCheck": {
> > +        "IgnoreHeaderFile": []
> > +    },
> > +
> > +    ## options defined ci/Plugin/SpellCheck
> > +    "SpellCheck": {
> > +        "AuditOnly": True,           # Fails test but
> run in AuditOnly mode to collect
> > log
> > +        "IgnoreStandardPaths": [     # Standard
> Plugin defined paths that should
> > be ignore
> > +            "*.c", "*.asm", "*.h", "*.nasm", "*.s",
> "*.asl", "*.inf"
> > +        ],
> > +        "IgnoreFiles": [             # use gitignore
> syntax to ignore errors in matching
> > files
> > +
> "Library/LzmaCustomDecompressLib/Sdk/DOC/*"
> > +        ],
> > +        "ExtendWords": [           # words to extend
> to the dictionary for this
> > package
> > +            "LIGHTGRAY",
> > +            "DARKGRAY",
> > +            "LIGHTBLUE",
> > +            "LIGHTGREEN",
> > +            "LIGHTCYAN",
> > +            "LIGHTRED",
> > +            "LIGHTMAGENTA",
> > +            "FVMAIN",
> > +            "VARCHECKPCD",
> > +            "Getxx",
> > +            "lzturbo"
> > +        ],
> > +        "AdditionalIncludePaths": [] # Additional
> paths to spell
> > + check relative to
> > package root (wildcards supported)
> > +    }
> > +}
> > --
> > 2.21.0.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#50263): https://edk2.groups.io/g/devel/message/50263
Mute This Topic: https://groups.io/mt/44874075/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-