This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.CodeQL.Cli.
Summary
Tool for generating report
- Assembly
- Cake
.CodeQL .Cli .dll - Namespace
- Cake
.CodeQL .Cli .Report - Base Types
-
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
Type["CodeQLSecurityReportToolSettings"]
class Type type-node
Syntax
public class CodeQLSecurityReportToolSettings : ToolSettingsConstructors
| Name | Summary |
|---|---|
| Code |
Properties
| Name | Value | Summary |
|---|---|---|
| GitHubApiUrl | string |
GitHub API URL. Defaults to "https://api.github.com"
|
| GitHubToken | string |
The GitHub Personal Access Token that has the necessary access for security and dependency API endpoints.
|
| OutputDirectory | DirectoryPath |
The directory to output the PDF report to. This will be created if it does not exist. Defaults to "./".
|
| Redirect |
bool |
Gets or sets the process option to redirect standard error
|
| Redirect |
bool |
Gets or sets the process option to redirect standard output
|
| Repository | string |
The repository that contains the source code, in <owner>/<repository_name><owner>/<repository_name> form, e.g. peter-murray/node-hue-api
|
| SarifReportDirectory | DirectoryPath |
The directory containing the SARIF report files. Defaults to "../results";
|
| Template | Nullable |
The report template type used to render the report.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|