CodeQLReportInstallToolSettings Class

Summary

Tool for installing CodeQL Github Security Report cli on the host machine
Assembly
Cake.CodeQL.Cli.dll
Namespace
Cake.CodeQL.Cli.Report
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["CodeQLReportInstallToolSettings"] class Type type-node

Syntax

public class CodeQLReportInstallToolSettings

Constructors

Properties

Name Value Summary
Force bool
Gets or Sets whether to force an install of CodeQL Github Security Report cli even if the tool is already installs
InstallDirectory DirectoryPath
Gets or sets the install directory that CodeQL Github Security Report cli will be extracted to. Defaults to "./tools/codeql/reports"
Repository string
The repository that contains the install download for, in <owner>/<repository_name>< form.
Version string
Version of the Github Security Report cli to download. Defaults to v2. Must match a tag on the property.
WorkingDirectory DirectoryPath
Gets or sets the working directory

Extension Methods

Name Value Summary
Dump<CodeQLReportInstallToolSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CodeQLReportInstallToolSettings>(CodeQLReportInstallToolSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CodeQLReportInstallToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CodeQLReportInstallToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CodeQLReportInstallToolSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CodeQLReportInstallToolSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin