CodeQLAliases Class

Summary

CodeQL Cli aliases
Assembly
Cake.CodeQL.Cli.dll
Namespace
Cake.CodeQL.Cli
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["CodeQLAliases"] class Type type-node

Syntax

public static class CodeQLAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
CodeQLAnalyzeDatabase(ICakeContext, CodeQLAnalyzeDatabaseToolSettings) void
Analyzes a CodeQL database for vunerabilities and summarizes the results in a SARIF file. Assumes the codeQL cli is installed on the host and available in the terminal path.
static
CodeQLCreateDatabase(ICakeContext, CodeQLCreateDatabaseToolSettings) void
Creates a CodeQL Databases that can be use for vunerability scanning. Assumes the codeQL cli is installed on the host and available in the terminal path.
static
CodeQLInstall(ICakeContext, CodeQLInstallToolSettings) void
Installs CodeQL on the host agent.
static
CodeQLReportGenerate(ICakeContext, CodeQLSecurityReportToolSettings) void
Generates an GitHub Advanced Security Code Scan Report
static
CodeQLReportInstall(ICakeContext, CodeQLReportInstallToolSettings) void
Installs GitHub Advanced Security Code Scan Report cli on the host agent.
static
CodeQLUploadResults(ICakeContext, CodeQLUploadResultsToolSettings) void
Uploads the results of a CodeQL analysis in SARIF file format to GitHub or GitHub Enterprise Server. Assumes the codeQL cli is installed on the host and available in the terminal path.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin