From df9111c2d381546ff23cdf327546ad49f51ce779 Mon Sep 17 00:00:00 2001 From: Michael Kubacki Date: Tue, 21 Jul 2026 20:42:07 -0400 Subject: [PATCH] Global: Set MarkdownLintCheck plugin to AuditOnly In preparation for the MarkdownLintCheck plugin being added to the repo, this change defaults the plugin to `AuditOnly` mode in each package. This allows package maintainers to enable the plugin as they see fit. Continuous-integration-options: PatchCheck.ignore-multi-package Signed-off-by: Michael Kubacki --- ArmPkg/ArmPkg.ci.yaml | 6 ++++++ ArmPlatformPkg/ArmPlatformPkg.ci.yaml | 6 ++++++ ArmVirtPkg/ArmVirtPkg.ci.yaml | 6 ++++++ CryptoPkg/CryptoPkg.ci.yaml | 6 ++++++ EmbeddedPkg/EmbeddedPkg.ci.yaml | 6 ++++++ EmulatorPkg/EmulatorPkg.ci.yaml | 6 ++++++ FatPkg/FatPkg.ci.yaml | 6 ++++++ FmpDevicePkg/FmpDevicePkg.ci.yaml | 6 ++++++ IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml | 6 ++++++ IntelFsp2WrapperPkg/IntelFsp2WrapperPkg.ci.yaml | 6 ++++++ ManageabilityPkg/ManageabilityPkg.ci.yaml | 6 ++++++ MdeModulePkg/MdeModulePkg.ci.yaml | 8 ++++++++ MdePkg/MdePkg.ci.yaml | 1 + NetworkPkg/NetworkPkg.ci.yaml | 6 ++++++ OvmfPkg/OvmfPkg.ci.yaml | 6 ++++++ PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml | 6 ++++++ PrmPkg/PrmPkg.ci.yaml | 6 ++++++ RedfishPkg/RedfishPkg.ci.yaml | 6 ++++++ SecurityPkg/SecurityPkg.ci.yaml | 6 ++++++ ShellPkg/ShellPkg.ci.yaml | 6 ++++++ SourceLevelDebugPkg/SourceLevelDebugPkg.ci.yaml | 6 ++++++ StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 6 ++++++ TcgTpmPkg/TcgTpmPkg.ci.yaml | 6 ++++++ UefiCpuPkg/UefiCpuPkg.ci.yaml | 6 ++++++ UefiPayloadPkg/UefiPayloadPkg.ci.yaml | 6 ++++++ UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml | 9 +++++++++ 26 files changed, 156 insertions(+) diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml index 14da56132e..9bd080a613 100644 --- a/ArmPkg/ArmPkg.ci.yaml +++ b/ArmPkg/ArmPkg.ci.yaml @@ -241,5 +241,11 @@ ], "AdditionalIncludePaths": [] # Additional paths to spell check # (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/ArmPlatformPkg/ArmPlatformPkg.ci.yaml b/ArmPlatformPkg/ArmPlatformPkg.ci.yaml index b42ffc7518..613a7ebe6b 100644 --- a/ArmPlatformPkg/ArmPlatformPkg.ci.yaml +++ b/ArmPlatformPkg/ArmPlatformPkg.ci.yaml @@ -135,5 +135,11 @@ ], "AdditionalIncludePaths": [] # Additional paths to spell check # (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/ArmVirtPkg/ArmVirtPkg.ci.yaml b/ArmVirtPkg/ArmVirtPkg.ci.yaml index 21cb190014..1927085467 100644 --- a/ArmVirtPkg/ArmVirtPkg.ci.yaml +++ b/ArmVirtPkg/ArmVirtPkg.ci.yaml @@ -134,5 +134,11 @@ # Reason: Expansion of macro that contains a print specifier. "FMT_CM_OBJECT_ID": "0x%lx" } + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/CryptoPkg/CryptoPkg.ci.yaml b/CryptoPkg/CryptoPkg.ci.yaml index 96d6df1e81..938c1f0cc7 100644 --- a/CryptoPkg/CryptoPkg.ci.yaml +++ b/CryptoPkg/CryptoPkg.ci.yaml @@ -157,5 +157,11 @@ "Library/OpensslLib/OpensslGen/providers/common/include/prov/der_wrap.h", "Library/OpensslLib/OpensslStub/uefiprov.c" ] + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/EmbeddedPkg/EmbeddedPkg.ci.yaml b/EmbeddedPkg/EmbeddedPkg.ci.yaml index f4956e679d..b9493d7279 100644 --- a/EmbeddedPkg/EmbeddedPkg.ci.yaml +++ b/EmbeddedPkg/EmbeddedPkg.ci.yaml @@ -91,5 +91,11 @@ "ExtendWords": [], # words to extend to the dictionary for this package "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/EmulatorPkg/EmulatorPkg.ci.yaml b/EmulatorPkg/EmulatorPkg.ci.yaml index 6090fe3363..4b49c6a03f 100644 --- a/EmulatorPkg/EmulatorPkg.ci.yaml +++ b/EmulatorPkg/EmulatorPkg.ci.yaml @@ -107,5 +107,11 @@ ], # words to extend to the dictionary for this package "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/FatPkg/FatPkg.ci.yaml b/FatPkg/FatPkg.ci.yaml index 804688c987..fb99efac16 100644 --- a/FatPkg/FatPkg.ci.yaml +++ b/FatPkg/FatPkg.ci.yaml @@ -65,5 +65,11 @@ "DMDEPKG", "lba's", ] + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/FmpDevicePkg/FmpDevicePkg.ci.yaml b/FmpDevicePkg/FmpDevicePkg.ci.yaml index 1e687a53fa..ec04aee83a 100644 --- a/FmpDevicePkg/FmpDevicePkg.ci.yaml +++ b/FmpDevicePkg/FmpDevicePkg.ci.yaml @@ -67,5 +67,11 @@ }, "Defines": { "BLD_*_CONTINUOUS_INTEGRATION": "TRUE", + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml b/IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml index bd6f4cc961..cdc73d8a5c 100644 --- a/IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml +++ b/IntelFsp2Pkg/IntelFsp2Pkg.ci.yaml @@ -89,5 +89,11 @@ "ExtendWords": [], # words to extend to the dictionary for this package "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/IntelFsp2WrapperPkg/IntelFsp2WrapperPkg.ci.yaml b/IntelFsp2WrapperPkg/IntelFsp2WrapperPkg.ci.yaml index 2d32bc65b4..a9a92f1c7e 100644 --- a/IntelFsp2WrapperPkg/IntelFsp2WrapperPkg.ci.yaml +++ b/IntelFsp2WrapperPkg/IntelFsp2WrapperPkg.ci.yaml @@ -91,5 +91,11 @@ "ExtendWords": [], # words to extend to the dictionary for this package "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/ManageabilityPkg/ManageabilityPkg.ci.yaml b/ManageabilityPkg/ManageabilityPkg.ci.yaml index e1621d2613..c43661a6d1 100644 --- a/ManageabilityPkg/ManageabilityPkg.ci.yaml +++ b/ManageabilityPkg/ManageabilityPkg.ci.yaml @@ -70,5 +70,11 @@ "Defines": { "BLD_*_CONTINUOUS_INTEGRATION": "TRUE" + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/MdeModulePkg/MdeModulePkg.ci.yaml b/MdeModulePkg/MdeModulePkg.ci.yaml index 6056e263a6..724795ef56 100644 --- a/MdeModulePkg/MdeModulePkg.ci.yaml +++ b/MdeModulePkg/MdeModulePkg.ci.yaml @@ -120,5 +120,13 @@ "canthave" ], "AdditionalIncludePaths": [] # Additional paths to spell check relative to package root (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [ "Universal/RegularExpressionDxe/oniguruma", # submodule outside of control + "Library/BrotliCustomDecompressLib/brotli" # submodule outside of control + ] } } diff --git a/MdePkg/MdePkg.ci.yaml b/MdePkg/MdePkg.ci.yaml index c686dcbdd9..9823e6c6ba 100644 --- a/MdePkg/MdePkg.ci.yaml +++ b/MdePkg/MdePkg.ci.yaml @@ -242,6 +242,7 @@ ## options defined .pytool/Plugin/MarkdownLintCheck "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped "IgnoreFiles": [ "Library/MipiSysTLib/mipisyst" # submodule outside of control ] # package root relative file, folder, or glob pattern to ignore } diff --git a/NetworkPkg/NetworkPkg.ci.yaml b/NetworkPkg/NetworkPkg.ci.yaml index 24695f97d9..817fa80b80 100644 --- a/NetworkPkg/NetworkPkg.ci.yaml +++ b/NetworkPkg/NetworkPkg.ci.yaml @@ -84,5 +84,11 @@ "BLD_*_NETWORK_HTTP_BOOT_ENABLE": "TRUE", "BLD_*_NETWORK_ISCSI_ENABLE": "TRUE", "BLD_*_NETWORK_PXE_BOOT_ENABLE": "TRUE", + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml index f44c1b8f2d..454f3015fc 100644 --- a/OvmfPkg/OvmfPkg.ci.yaml +++ b/OvmfPkg/OvmfPkg.ci.yaml @@ -105,5 +105,11 @@ # options defined in .pytool/Plugin/UncrustifyCheck "UncrustifyCheck": { "IgnoreFiles": ["VbeShim.h"] + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml b/PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml index 278bb43969..3d2d7cf5b0 100644 --- a/PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml +++ b/PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml @@ -61,5 +61,11 @@ "PCATCHIPSET", "TXRDY" ] + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/PrmPkg/PrmPkg.ci.yaml b/PrmPkg/PrmPkg.ci.yaml index 0c6e4c9e01..0dc5bd28fe 100644 --- a/PrmPkg/PrmPkg.ci.yaml +++ b/PrmPkg/PrmPkg.ci.yaml @@ -115,5 +115,11 @@ # should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check # (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/RedfishPkg/RedfishPkg.ci.yaml b/RedfishPkg/RedfishPkg.ci.yaml index b95e8bfdc7..d8ee40450d 100644 --- a/RedfishPkg/RedfishPkg.ci.yaml +++ b/RedfishPkg/RedfishPkg.ci.yaml @@ -106,5 +106,11 @@ "Defines": { "BLD_*_CONTINUOUS_INTEGRATION": "TRUE", "BLD_*_REDFISH_ENABLE": "TRUE" + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/SecurityPkg/SecurityPkg.ci.yaml b/SecurityPkg/SecurityPkg.ci.yaml index d54903293c..f144e38923 100644 --- a/SecurityPkg/SecurityPkg.ci.yaml +++ b/SecurityPkg/SecurityPkg.ci.yaml @@ -134,5 +134,11 @@ # Replace ternary operator in debug string with single specifier 'Index == COLUME_SIZE/2 ? " | %02x" : " %02x"': "%d" } + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/ShellPkg/ShellPkg.ci.yaml b/ShellPkg/ShellPkg.ci.yaml index 2c3a70d84b..c62ffe570f 100644 --- a/ShellPkg/ShellPkg.ci.yaml +++ b/ShellPkg/ShellPkg.ci.yaml @@ -72,5 +72,11 @@ "ExtendWords": [], # words to extend to the dictionary for this package "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/SourceLevelDebugPkg/SourceLevelDebugPkg.ci.yaml b/SourceLevelDebugPkg/SourceLevelDebugPkg.ci.yaml index 295a11640e..24e9ac1947 100644 --- a/SourceLevelDebugPkg/SourceLevelDebugPkg.ci.yaml +++ b/SourceLevelDebugPkg/SourceLevelDebugPkg.ci.yaml @@ -117,5 +117,11 @@ ], "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/StandaloneMmPkg/StandaloneMmPkg.ci.yaml b/StandaloneMmPkg/StandaloneMmPkg.ci.yaml index 7d9b0c9cac..232c60e20f 100644 --- a/StandaloneMmPkg/StandaloneMmPkg.ci.yaml +++ b/StandaloneMmPkg/StandaloneMmPkg.ci.yaml @@ -97,5 +97,11 @@ # should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check # (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/TcgTpmPkg/TcgTpmPkg.ci.yaml b/TcgTpmPkg/TcgTpmPkg.ci.yaml index 4f47b424a1..e930ce4dc4 100644 --- a/TcgTpmPkg/TcgTpmPkg.ci.yaml +++ b/TcgTpmPkg/TcgTpmPkg.ci.yaml @@ -135,5 +135,11 @@ "Private/Include/Standard/time.h", "Private/Include/Standard/unistd.h" ] + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/UefiCpuPkg/UefiCpuPkg.ci.yaml b/UefiCpuPkg/UefiCpuPkg.ci.yaml index 57867ddf98..00def953c5 100644 --- a/UefiCpuPkg/UefiCpuPkg.ci.yaml +++ b/UefiCpuPkg/UefiCpuPkg.ci.yaml @@ -86,5 +86,11 @@ "ExtendWords": [], # words to extend to the dictionary for this package "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported) + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/UefiPayloadPkg/UefiPayloadPkg.ci.yaml b/UefiPayloadPkg/UefiPayloadPkg.ci.yaml index 84e3f14b68..dbdda74961 100644 --- a/UefiPayloadPkg/UefiPayloadPkg.ci.yaml +++ b/UefiPayloadPkg/UefiPayloadPkg.ci.yaml @@ -97,5 +97,11 @@ "BLD_*_SERIAL_DRIVER_ENABLE": "FALSE", "BLD_*_BUILD_ARCH": "", "BLD_*_SECURE_BOOT_ENABLE": "TRUE", + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [] # package root relative file, folder, or glob pattern to ignore } } diff --git a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml index 0e3fd4411a..0d78a6ae69 100644 --- a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml +++ b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml @@ -130,6 +130,15 @@ "Library/CmockaLib/cmocka/**", "Library/GoogleTestLib/googletest/**", "Library/SubhookLib/subhook/**" + ], + }, + + ## options defined .pytool/Plugin/MarkdownLintCheck + "MarkdownLintCheck": { + "AuditOnly": True, # If True, log all errors and then mark as skipped + "IgnoreFiles": [ + "Library/CmockaLib/cmocka", # cmocka is submodule outside of control + "Library/GoogleTestLib/googletest" # googletest is submodule outside of control ] } }