Tianocore/edk2.git/BaseTools/Scripts/PatchCheck.py, branch dependabot/github_actions/github/codeql-action-4

BaseTools: PatchCheck.py: Allow MultiPkg Commits For Subject Check

2025-09-05T06:32:06+00:00

Subject Check was added to PatchCheck.py to enforce that if a package was touched in a commit that it be referenced in the subject line. However, this is impractical for multipackage commits with many packages, e.g. when stack cookies were added, every package was touched, but in a rote way, and it is not reasonable to put every package in a subject line. This updates PatchCheck.py to check if ignore_multi_package is set and if so only require that package names be included in the subject if there are fewer than 3 packages touched. Otherwise, PatchCheck will require the message to start with `Global:` to indicate it touches more than 3 packages. Signed-off-by: Oliver Smith-Denny

BaseTools/PatchCheck.py: Check CI Options Before Parsing

2025-09-05T06:32:06+00:00

PatchCheck.py currently parses the CI options as the last step it does before reporting results. This means that the other checking logic cannot use any of the CI options that are passed in. This updates the order of operations to process CI options before running other checks so that they can be used in performing checks. Signed-off-by: Oliver Smith-Denny

BaseTools/PatchCheck.py: permit at least 20 characters after ':'

2025-07-02T20:14:21+00:00

Commit b55530ad4460 ("BaseTools/PatchCheck.py: verify commit message lists package(s)") introduced a check for the requirement to enumerate all modified packages in the commit subject line. But it did leave the maximum line length at 75 characters (for non-CVE commits), which can get a bit cramped for changes to several packages. Introduce a new arbitrary "at least 20 characters after the :" limit. Signed-off-by: Leif Lindholm

BaseTools/PatchCheck.py: clean up subject line length handling

2025-07-02T20:14:21+00:00

Use a temporary variable for max subject line length and log result of test in one location. Signed-off-by: Leif Lindholm

BaseTools/PatchCheck.py: drop redundant line count check

2025-07-02T20:14:21+00:00

Before doing the subject line length check, the script checks that the number of lines in the commit message (including subject) is not less than or equal to zero - and returns if it is. However, then the test for whether the subject line starts with a CVE tag inexplicably also checks for whether the number of lines are greater than or equal to one. This is just clutter, so drop it. Signed-off-by: Leif Lindholm

BaseTools/PatchCheck.py: verify commit message lists package(s)

2025-06-25T16:22:25+00:00

Verify that the subject line matches the basic {Package}[,Package]: format _or_ the Revert "" format. Non-package top-level directories are treated as packages. Suggested-by: Ard Biesheuvel Signed-off-by: Leif Lindholm

BaseTools/PatchCheck.py: pass list of packages to CommitMessageCheck

2025-06-25T16:22:25+00:00

In order to enable subject line format compliance checking in following patches, pass through a list of modified packages to CommitMessageCheck. Signed-off-by: Leif Lindholm

BaseTools/PatchCheck.py: make get_parent_packages return directory names

2025-06-25T16:22:25+00:00

The get_parent_packages function in CheckGitCommits returns the path of non-package directories, but in fact returns the path of the .dec file for actual packages. Align the handling to be more consistent and return only directory names, regarding of how it was found. Signed-off-by: Leif Lindholm

BaseTools: Add line number to PatchCheck error messages

2025-06-06T18:50:54+00:00

PatchCheck error messages can be improved by adding the line number. The line itself may consist of only whitespace for some errors. Adding the line number can help better locate the error source. Signed-off-by: Gary Beihl

BaseTools: Remove Pip BaseTools

2024-09-10T00:41:53+00:00

BaseTools was moved out to a separate repo and consumed as a pip module by edk2 CI. This process has not led to the desired goals of doing so, so this patch removes the pip based BaseTools from edk2 CI. The original goal of moving BaseTools to a pip module was primarily to speed up the development process, as the old edk2 mailing list was slow. However, with edk2 moving to PRs, it now actually slows the BaseTools development process to have to do a PR in another repo, publish the module, and then make a PR in edk2 to consume the new BaseTools. It also holds up using the features in a new BaseTools in other PRs. There were other goals of moving, such as allowing projects to use the BaseTools outside of edk2. This can still be accomplished outside of this PR, this PR simply stops edk2 CI from using the pip module. Continuous-integration-options: PatchCheck.ignore-multi-package Signed-off-by: Oliver Smith-Denny