History

Michael Kubacki 62bf2aefc7 .pytool/Plugin: Improve plugin log messages Improves the CI output with more actionable messages and downgrades some errors/warnings. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>		2024-07-17 23:19:06 +00:00
..
DependencyCheck.py	.pytool/Plugin: Improve plugin log messages	2024-07-17 23:19:06 +00:00
DependencyCheck_plug_in.yaml	.pytool/Plugin: Add CI plugins	2019-11-11 13:02:03 -08:00
Readme.md	.pytool/Plugin: Add CI plugins	2019-11-11 13:02:03 -08:00

Readme.md

Depdendency Check Plugin

A CiBuildPlugin that finds all modules (inf files) in a package and reviews the packages used to confirm they are acceptable. This is to help enforce layering and identify improper dependencies between packages.

Configuration

The plugin must be configured with the acceptabe package dependencies for the package.

"DependencyCheck": {
    "AcceptableDependencies": [],
    "AcceptableDependencies-<MODULE_TYPE>": [],
    "IgnoreInf": []
}

AcceptableDependencies

Package dec files that are allowed in all INFs. Example: MdePkg/MdePkg.dec

AcceptableDependencies-<MODULE_TYPE>

OPTIONAL Package dependencies for INFs that have module type <MODULE_TYPE>. Example: AcceptableDependencies-HOST_APPLICATION.

IgnoreInf

OPTIONAL list of INFs to ignore for this dependency check.