Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.github.codeql-action.upload-sarif.v4.CodeqlActionUploadSarif

With1.6.0

Properties
Methods

class With

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

Properties

link

sarif_file: String?Source

The SARIF file or directory of SARIF files to be uploaded to GitHub code scanning. See https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions for information on the maximum number of results and maximum file size supported by code scanning.

Default if unspecified: "../results"
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

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

category: String?Source

String used by Code Scanning for matching the analyses
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"

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.