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

With1.6.0

Properties
Methods

class With

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

Properties

link
tools: String?Source
By default, the Action will use the recommended version of the CodeQL Bundle to analyze your project. You can override this choice using this input. One of:
- A local path to a CodeQL Bundle tarball, or
- The URL of a CodeQL Bundle tarball GitHub release asset, or
- A special value linked which uses the version of the CodeQL tools that the Action has been bundled with.
- A special value nightly which uses the latest nightly version of the CodeQL tools. Note that this is unstable and not recommended for production use.
If not specified, the Action will check in several places until it finds the CodeQL tools.
link

hidden

languagesList: Listing<String>?Source

A comma-separated list of CodeQL languages to analyze. Due to the performance benefit of parallelizing builds, we recommend specifying languages to analyze using a matrix and providing \$\{{ matrix.language }} as this input. For more information, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed.
link

languages: String?Source

A comma-separated list of CodeQL languages to analyze. Due to the performance benefit of parallelizing builds, we recommend specifying languages to analyze using a matrix and providing \$\{{ matrix.language }} as this input. For more information, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed.

To set as a Listing, use languagesList.
link
`build-mode`: ("none"|"autobuild"|"manual")?Source
The build mode that will be used to analyze the language. This input is only available when analyzing a single CodeQL language per job, for example using a matrix. Available build modes will differ based on the language being analyzed. One of:
- none: The database will be created without building the source code. Available for all interpreted languages and some compiled languages.
- autobuild: The database will be created by attempting to automatically build the source code. Available for all compiled languages.
- manual: The database will be created by building the source code using a manually specified build command. To use this build mode, specify manual build steps in your workflow between the init and analyze steps. Available for all compiled languages.
link
`analysis-kinds`: ("code-scanning"|"code-quality")?Source
Internal A comma-separated list of analysis kinds to enable. This input is intended for internal-use only at this time and the behaviour is subject to changes. Some features may not be available depending on which analysis kinds are enabled. Available options are:
- code-scanning: The default, security-focused analysis.
- code-quality: Analysis focused on code quality. This must be enabled in conjunction with code-scanning.
Default if unspecified: "code-scanning"
link

token: String?Source

GitHub token to use for authenticating with this instance of GitHub. To download custom packs from multiple registries, use the registries input.

Default if unspecified: "${{ github.token }}"
link
registries: String?Source

Use this input only when you need to download CodeQL packages from another instance of GitHub. If you only need to download packages from this GitHub instance, use the token input instead.
A YAML string that defines the list of GitHub container registries to use for downloading packs. The string is in the following form (the | is required on the first line):
```
registries: |
    - url: https://containers.GHEHOSTNAME1/v2/
      packages:
        - my-company/*
        - my-company2/*
      token: \$\{{ secrets.GHEHOSTNAME1_TOKEN }}

    - url: https://ghcr.io/v2/
      packages: */*
      token: \$\{{ secrets.GHCR_TOKEN }}
```
The url property contains the URL to the container registry you want to connect to.

The packages property contains a single glob string or a list of glob strings, specifying which packages should be retrieved from this particular container registry. Order is important. Earlier entries will match before later entries.

The token property contains a connection token for this registry.
link

matrix: String?Source

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

`config-file`: String?Source

Path of the config file to use
link

`db-location`: String?Source

Path where CodeQL databases should be created. If not specified, a temporary directory will be used.
link

hidden

codeQLConfig: Config?Source

Configuration settings for CodeQL.
link

config: String?Source

Configuration passed as a YAML string in the same format as the config-file input.

This takes precedence over the config-file input.

To specify config in a structured way, set codeQLConfig.
link

hidden

queriesList: Listing<String>?Source

Comma-separated list of additional queries to run.

By default, this overrides the same setting in a configuration file; prefix with "+" to use both sets of queries.
link

queries: String?Source

Comma-separated list of additional queries to run. By default, this overrides the same setting in a configuration file; prefix with "+" to use both sets of queries.

To set as a Listing, use queriesList.
link

hidden

`quality-queries-list`: Listing<String>?Source

Internal DEPRECATED. Comma-separated list of code quality queries to run.
link

`quality-queries`: String?Source

Internal DEPRECATED. Comma-separated list of code quality queries to run.

To set as a Listing, use quality-queries-list.
link

hidden

packsList: Listing<String>?Source

Comma-separated list of packs to run. Reference a pack in the format scope/name[@version]. If version is not specified, then the latest version of the pack is used. By default, this overrides the same setting in a configuration file; prefix with "+" to use both sets of packs. This input is only available in single-language analyses. To use packs in multi-language analyses, you must specify packs in the codeql-config.yml file.
link

packs: String?Source

Comma-separated list of packs to run. Reference a pack in the format scope/name[@version]. If version is not specified, then the latest version of the pack is used. By default, this overrides the same setting in a configuration file; prefix with "+" to use both sets of packs. This input is only available in single-language analyses. To use packs in multi-language analyses, you must specify packs in the codeql-config.yml file.

To set as a Listing, use packsList.
link

`external-repository-token`: String?Source

A token for fetching external config files and queries if they reside in a private repository in the same GitHub instance that is running this action.
link

`setup-python-dependencies`: Boolean?Source

DEPRECATED. This option is ignored since CodeQL Action no longer installs Python dependencies as of versions 3.25.0 and 2.25.0.
link

`source-root`: String?Source

Path of the root source code directory, relative to $GITHUB_WORKSPACE.
link

ram: Int?Source

The amount of memory in MB that can be used by CodeQL extractors. By default, CodeQL extractors 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). This input also sets the amount of memory that can later be used by the "analyze" action.
link

threads: Int?Source

The number of threads that can be used by CodeQL extractors. By default, CodeQL extractors 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). This input also sets the number of threads that can later be used by the "analyze" action.
link

debug: Boolean?Source

Enable debugging mode. This will result in more output being produced which may be useful when debugging certain issues. Debugging mode is enabled automatically when step debug logging is turned on.

Default if unspecified: "false"
link

`debug-artifact-name`: String?Source

The name of the artifact to store debugging information in. This is only used when debug mode is enabled.
link

`debug-database-name`: String?Source

The name of the database uploaded to the debugging artifact. This is only used when debug mode is enabled.
link

`trap-caching`: Boolean?Source

Explicitly enable or disable TRAP caching rather than respecting the feature flag for it.
link

`dependency-caching`: Boolean?Source

Explicitly enable or disable caching of project build dependencies.
link

`check-run-id`: String?Source

Internal The ID of the check run, as provided by the Actions runtime environment. Do not set this value manually.

Default if unspecified: "${{ job.check_run_id }}"

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.