runChecks

R2026b

Run all project checks

collapse all in page

Syntax

checkResults = runChecks(proj)

Description

checkResults = runChecks(proj) runs checks on the specified project. The checks detect problems with the project integrity such as missing files, unsaved files, files not under source control, or out-of-date derived files.

example

Examples

collapse all

Open the Times Table App project. Use currentProject to create a project object from the currently loaded project.

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

Run all project checks.

checkResults = runChecks(proj)
 checkResults = 

  12×1 ProjectCheckResult array with properties:

    ID
    Description
    Passed
    ProblemFiles

Create a table from the checkResults array.

summary = table(checkResults)
 summary =

  12×3 table

    Passed                                  Description                                                               ID                             
    ______    _______________________________________________________________________    ____________________________________________________________

    true      "All files under source control are in the project"                        "Project:Checks:AllFilesUnderSourceControlAreInProject"     
    true      "All project files are under source control"                               "Project:Checks:AllProjectFilesUnderSourceControl"          
    true      "No models in the project have mismatching file formats"                   "Project:Checks:MDLToSLX"                                   
    true     "All project definition files are under source control"                    "Project:Checks:ProjectDefinitionFilesAreUnderSourceControl"
    true      "All project files and folders exist on the file system"                   "Project:Checks:ProjectFilesExist"                          
    true      "All project folders on the MATLAB search path are on the project path"    "Project:Checks:ProjectPath"                                
    true      "All projects in sub-folders are referenced by this project"               "Project:Checks:ReferencedSubprojects"                      
    true      "No slprj or sfprj folders in the project"                                 "Project:Checks:SLPRJ"                                      
    true      "Project has no duplicates or missing built-in labels"                     "Project:Checks:MissingOrDuplicateLabelsInProject"          
    true      "No out of date P-code files"                                              "Project:Checks:OutdatedPcodedFiles"                        
    true      "No case mismatch detected in project files, paths, and references"        "Project:Checks:PathCaseSensitive"                          
    true      "No project files have unsaved changes"                                    "Project:Checks:UnsavedProjectFiles"

Note

Running source control related checks requires a full clone of the repository. In a CI/CD pipeline, some repository hosting platforms such as GitLab® default to a shallow clone with a depth of 50 per job. Set the clone and fetch depth to 0 to create a full clone instead.

Use the ID, Passed, and ProblemFiles properties to get information about an individual check.

id = checkResults(1).ID
status = checkResults(1).Passed
problems = checkResults(1).ProblemFiles

Input Arguments

collapse all

Project, specified as a matlab.project.Project object. Use currentProject to create a project object from the currently loaded project.

Output Arguments

collapse all

Project checks, returned as an array of ProjectCheckResult objects with properties.

Version History

Introduced in R2020a

expand all

See Also

|

Topics