Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions

com.github.actions.github.`codeql-action`.Config1.6.0

Overview
Properties
Methods
Classes
Type Aliases

module com.github.actions.github.`codeql-action`.Config

Configuration values when initializing CodeQL.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.github.actions@1.6.0#/github/codeql-action/Config.pkl
Source code:: Config.pkl
Known subtypes in package:
Known usages in package:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link
packs: (Listing<String>|Packs)?Source

The query packs used for scanning.
The full format for specifying a query pack is scope/name[@version][:path]. Both version and path are optional. version is semver version range. If it is missing, the latest version is used.

If you have a workflow that generates more than one CodeQL database, you can specify any CodeQL query packs to run in a custom configuration file using a nested map of packs.

Example:
```
packs {
  "scope/pack1"
  "scope/pack2@1.2.3"
}
```
Example of using different packs for different analyses:
```
packs = new Packs {
  ["javascript"] {
    "scope/js-pack1"
  }
  ["java"] {
    "scope/java-pack1"
  }
}
```
See https://docs.github.com/en/code-security/reference/code-scanning/workflow-configuration-options#specifying-codeql-query-packs
link

`threat-models`: "local"?Source

The default threat model includes remote sources of untrusted data. You can extend the CodeQL threat model to include local sources of untrusted data (for example: command-line arguments, environment variables, file systems, and databases) by specifying
threat-model = "local"
link

queries: Listing<Query>?Source

Additional queries to run as part of the scan.

See https://docs.github.com/en/code-security/reference/code-scanning/workflow-configuration-options#specifying-additional-queries
link

`disable-default-queries`: Boolean?Source

Disable default security queries.

See https://docs.github.com/en/code-security/reference/code-scanning/workflow-configuration-options#disabling-the-default-queries
link

`query-filters`: Listing<QueryFilter>?Source

Specify queries to include or exclude in the analysis.

See https://docs.github.com/en/code-security/reference/code-scanning/workflow-configuration-options#excluding-specific-queries-from-analysis
link

paths: Listing<String>?Source

Restrict scanning to just the specified set of paths.

See https://docs.github.com/en/code-security/reference/code-scanning/workflow-configuration-options#specifying-directories-to-scan
link

`paths-ignore`: Listing<String>?Source

Exclude directories from scanning.

See https://docs.github.com/en/code-security/reference/code-scanning/workflow-configuration-options#specifying-directories-to-scan

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```

Classes

Type Aliases

link

typealias

Packs = Mapping<String, Listing<String>>Source