Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.github.codeql-action.analyze.v4.CodeqlActionAnalyze

With1.6.0

Properties
Methods

class With

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

check_name: String?Source

The name of the check run to add text to.
link

output: String?Source

The path of the directory in which to save the SARIF results from the CodeQL CLI.

Default if unspecified: "../results"
link

upload: ("always"|"failure-only"|"never")?Source

Upload the SARIF file to Code Scanning. Defaults to 'always' which uploads the SARIF file to Code Scanning for successful and failed runs. 'failure-only' only uploads debugging information to Code Scanning if the workflow run fails, for users post-processing the SARIF file before uploading it to Code Scanning. 'never' avoids uploading the SARIF file to Code Scanning, even if the code scanning run fails. This is not recommended for external users since it complicates debugging.

Default if unspecified: "always"
link

`cleanup-level`: ("none"|"brutal"|"normal"|"light")?Source

DEPRECATED. This option is ignored since, for performance reasons, the CodeQL Action automatically manages cleanup of intermediate results.
link

ram: Int?Source

The amount of memory in MB that can be used by CodeQL for database finalization and query execution. By default, this action will use the same amount of memory as previously set in the "init" action. If the "init" action also does not have an explicit "ram" input, this action will use most of the memory available in the system (which for GitHub-hosted runners is 6GB for Linux, 5.5GB for Windows, and 13GB for macOS).
link

`add-snippets`: Boolean?Source

Deprecated: The input "add-snippets" has been removed and no longer has any effect.

Does not have any effect.
link

`skip-queries`: Boolean?Source

If this option is set, the CodeQL database will be built but no queries will be run on it. Thus, no results will be produced.

Default if unspecified: "false"
link

threads: Int?Source

The number of threads that can be used by CodeQL for database finalization and query execution. By default, this action will use the same number of threads as previously set in the "init" action. If the "init" action also does not have an explicit "threads" input, this action will use all the hardware threads available in the system (which for GitHub-hosted runners is 2 for Linux and Windows and 3 for macOS).
link

checkout_path: String?Source

The path at which the analyzed repository was checked out. Used to relativize any absolute paths in the uploaded SARIF file.

Default if unspecified: "${{ github.workspace }}"
link

ref: String?Source

The ref where results will be uploaded. If not provided, the Action will use the GITHUB_REF environment variable. If provided, the sha input must be provided as well. This input is ignored for pull requests from forks. Expected format: refs/heads/, refs/tags/, refs/pull//merge, or refs/pull//head.
link

sha: String?Source

The sha of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable. If provided, the ref input must be provided as well. This input is ignored for pull requests from forks.
link

category: String?Source

String used by Code Scanning for matching the analyses
link

`upload-database`: Boolean?Source

Whether to upload the resulting CodeQL database

Default if unspecified: "true"
link

`post-processed-sarif-path`: String?Source

Before uploading the SARIF files produced by the CodeQL CLI, the CodeQL Action may perform some post-processing on them. Ordinarily, these post-processed SARIF files are not saved to disk. However, if a path is provided as an argument for this input, they are written to the specified directory.
link

`wait-for-processing`: Boolean?Source

If true, the Action will wait for the uploaded SARIF to be processed before completing.

Default if unspecified: "true"
link

token: String?Source

GitHub token to use for authenticating with this instance of GitHub. The token must be the built-in GitHub Actions token, and the workflow must have the security-events: write permission. Most of the time it is advisable to avoid specifying this input so that the workflow falls back to using the default value.

Default if unspecified: "${{ github.token }}"
link

matrix: String?Source

Default if unspecified: "${{ toJson(matrix) }}"
link

`expect-error`: Boolean?Source

Internal It is an error to use this input outside of integration testing of the codeql-action.

Default if unspecified: "false"

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.