whisperity/CodeChecker Static Analysis

Execute C/C++ static analysis of LLVM/Clang (Clang Static Analyzer and Clang-Tidy) driven via CodeChecker.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
install-custom	Whether to download, check out, and build a CodeChecker package manually in the CI.	yes	false
repository	The CodeChecker repository to check out and build from.	yes	Ericsson/CodeChecker
version	The version of the CodeChecker suite to obtain and execute. Might be a Git commit SHA, a branch name, or a tag if building a custom package, or a release version if downloading from PyPI. If "master" and downloading from PyPI, fetch the latest release.	yes	master
llvm-version	The major version of LLVM to install and use. LLVM is installed from the community PPA at http://apt.llvm.org. The value MUST be a major version (e.g. 13) that is supported by the PPA for the OS used! If "latest", automatically gather the latest version. If "ignore", do not install anything. (Not recommended.)	yes	latest
config	The CodeChecker configuration JSON that contains for each CodeChecker action (analyze, parse, ...) the list of flags that should be appended to the invocation of the command.	no	—
logfile	The location of the JSON Compilation Database for the project. This file describes how the project is compiled, and thus how it should be analysed. Mutually exclusive with "build-command".	no	—
build-command	The build command to execute and log for the creation of a JSON Compilation Database. Mutually exclusive with "logfile".	no	—
analyze-output	The output directory where the raw analysis output should be stored. If left the default empty, the path will be generated automatically.	no	""
ctu	Whether to enable Cross Translation Unit (CTU) analysis in the Clang Static Analyzer.	yes	false
ignore-analyze-crashes	If set to "true", the "analyze" action will ALWAYS pass, and not report a failure if some analysis jobs fail to execute due to internal crashes in the Clang analysers.	yes	true
report-converter	Whether to perform report conversion from analyses executed by third-party analysers instead of driving the analysis via CodeChecker directly.	yes	false
original-analyser	The type of the third-party analyser which performed the analysis. Passed to the report converter executable, as a mandatory input parameter.	no	—
original-analysis-output	The location of the analysis data emitted by the third-party analyser. Passed to the report converter executable, as a mandatory input parameter.	no	—
diff	Whether to enable calculating the different of the current analysis results against a run stored on a CodeChecker server. If enabled, other flags, such as "diff-url" must also be set.	yes	false
diff-url	The CodeChecker product URL (usually in the format of http://example.com/ProductName) where the diff should connect to. Mandatory if "diff" is true.	no	—
diff-username	If the server requires authentication, the username to authenticate with.	no	—
diff-password	The password (or generated private access token) corresponding to the user.	no	—
diff-run-name	An identifying name of the analysis run. A run usually correlates to a set of configuration, e.g. analysis mode, branch, etc. If left default, the name is automatically generated from the current repository and branch name.	yes	__DEFAULT__
store	Whether to enable storing the results to a CodeChecker server. If enabled, other flags, such as "store-url" must also be set.	yes	false
store-url	The CodeChecker product URL (usually in the format of http://example.com/ProductName) where the store should connect to. Mandatory if "store" is true.	no	—
store-username	If the server requires authentication, the username to authenticate with.	no	—
store-password	The password (or generated private access token) corresponding to the user.	no	—
store-run-name	An identifying name of the analysis run. A run usually correlates to a set of configuration, e.g. analysis mode, branch, etc. If left default, the name is automatically generated from the current repository and branch name.	yes	__DEFAULT__

Outputs

name	description
codechecker-version	The version of the installed CodeChecker package.
codechecker-hash	The Git hash of the installed CodeChecker package.
llvm-version	The version of the installed LLVM package, if the install was requested.
logfile	The location of the JSON Compilation Database that was used for the analysis.
analyze-output	The output directory where the raw analysis or converted output was stored to.
warnings	Whether the static analyser(s) reported any findings.
result-log	The file where the output of CodeChecker parse is written to verbatim.
result-html-dir	The output directory where the user-friendly HTML reports were stored to.
diff-html-dir	The output directory where the user-friendly HTML reports about the new findings (if "diff" was enabled) were stored to.
diff-run-name	The name of the analysis run against which the current reports were compared.
diff-result-log	The file where the output of CodeChecker cmd diff is written to verbatim.
warnings-in-diff	Whether the current analysis produced any reports that were NEW, compared to the configured analysis run on the server.
store-run-name	The name of the analysis run that the results were uploaded to.
store-successful	Whether storing the analysis results to the configured server was successful. Useful for breaking the build in a later step if the store action is deemed mandatory.