microsoft/Microsoft C++ Code Analysis Action
Run Microsoft C++ Code Analysis to produce SARIF files for use in github/codeql-action/upload-sarif@v1
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| cmakeBuildDirectory | The CMake build directory that should already be generated. | yes | — |
| buildConfiguration | The build Configuration (Release, Debug, etc.) to use. This is required if using a multi-configuration CMake generator. | no | — |
| ruleset | Ruleset file used to determine what checks are run. | — | NativeRecommendedRules.ruleset |
| ignoredPaths | Identical to setting "ignoredTargetPaths" and "ignoreSystemHeaders" for the given path. This is recommended over either option seperately. | — | — |
| ignoredTargetPaths | Any CMake targets defined inside these paths will be excluded from analysis. This is useful for excluding tests or locally built dependencies. List is ";" seperated, requires complete directory paths and can be absolute or relative to "github.workspace" | no | — |
| ignoredIncludePaths | Any includes contained inside these path will be excluded from analysis. This will only filter existing paths add not add any additional includes to the compiler. This is useful for excluding target includes or other custom includes added to CMake. List is ";" seperated, requires complete directory paths and can be absolute or relative to "github.workspace" | no | — |
| ignoreSystemHeaders | Uses /external arguments to ignore warnings from any headers marked as SYSTEM in CMake. | — | true |
| resultsPath | Optional path to generate the SARIF file to. If not supplied "results.sarif" will be created in the CMake build directory. Path can be absolute or relative to "github.workspace". | no | — |
| loadImplicitCompilerEnv | Load implicit includes/libs for the given MSVC toolset using Visual Studio Command Prompt. Set to false if already loaded or a custom include path is needed. | — | true |
| additionalArgs | Optional parameters to pass to every instance of the compiler. | no | — |
Outputs
| name | description |
|---|---|
| sarif | The path to the SARIF file that is generated containing all the results. |