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 uploading results to GitHub

Assembly

Cake.CodeQL.Cli.dll

Namespace

Cake.CodeQL.Cli.Upload

Base Types

ToolSettings
CodeQLToolSettings

graph BT Type-->Base0["CodeQLToolSettings"] click Base0 "/api/Cake.CodeQL.Cli/CodeQLToolSettings" Base0-->Base1["ToolSettings"] Type["CodeQLUploadResultsToolSettings"] class Type type-node

Syntax

public class CodeQLUploadResultsToolSettings : CodeQLToolSettings

Constructors

Name	Summary
CodeQLUploadResultsToolSettings()	Initializes a new instance of the `CodeQLUploadResultsToolSettings`

Properties

Name	Value	Summary
Command	string	Gets the command which should be run. Inherited from CodeQLToolSettings
Commit	string	Specify the full SHA of the commit you analyzed.
GitHubAuthStdin	bool	Optional. Use to pass the CLI the GitHub App or personal access token created for authentication with GitHub's REST API via standard input. This is not needed if the command has access to a GITHUB_TOKEN environment variable set with this token.
GitHubUrl	string	Specify the URL for GitHub Enterprise Server. If blanks,defaults to to github.com.
RedirectStandardError	bool	Gets or sets the process option to redirect standard error Inherited from CodeQLToolSettings
RedirectStandardOutput	bool	Gets or sets the process option to redirect standard output Inherited from CodeQLToolSettings
Ref	string	Specify the name of the ref you checked out and analyzed so that the results can be matched to the correct code. For a branch use: refs/heads/BRANCH-NAME, for the head commit of a pull request use refs/pull/NUMBER/head, or for the GitHub-generated merge commit of a pull request use refs/pull/NUMBER/merge.
RepositoryName	string	Specify the OWNER/NAME of the repository to upload data to. The owner must be an organization within an enterprise that has a license for GitHub Advanced Security and GitHub Advanced Security must be enabled for the repository.
SarifFilePath	FilePath	Specify the SARIF file to load.

Methods

Name	Value	Summary
EvaluateCore(ProcessArgumentBuilder)	void	Evaluates the settings and writes them to args.

Extension Methods