Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.dependency-review-action.v4.DependencyReviewAction

With1.6.0

Properties
Methods

class With

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

Properties

link

`repo-token`: String?Source

Token for the repository. Can be passed in using {{ secrets.GITHUB_TOKEN }}.

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

`fail-on-severity`: ("low"|"moderate"|"high"|"critical")?Source

Don't block PRs below this severity. Possible values are low, moderate, high, critical.
link

hidden

`fail-on-scopes-list`: Listing<("unknown"|"runtime"|"development")>?Source

Dependency scopes to block PRs on. Comma-separated list. Possible values are 'unknown', 'runtime', and 'development' (e.g. "runtime, development")
link

`fail-on-scopes`: String?Source

Dependency scopes to block PRs on. Comma-separated list. Possible values are 'unknown', 'runtime', and 'development' (e.g. "runtime, development")

To set as a Listing, use fail-on-scopes-list.
link

`base-ref`: String?Source

The base git ref to be used for this check. Has a default value when the workflow event is pull_request or pull_request_target. Must be provided otherwise.
link

`head-ref`: String?Source

The head git ref to be used for this check. Has a default value when the workflow event is pull_request or pull_request_target. Must be provided otherwise.
link

`config-file`: String?Source

A path to the configuration file for the action.
link

hidden

`allow-licenses-list`: Listing<String>?Source

Comma-separated list of allowed licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
link

`allow-licenses`: String?Source

Comma-separated list of allowed licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")

To set as a Listing, use allow-licenses-list.
link

hidden

`deny-licenses-list`: Listing<String>?Source

Comma-separated list of forbidden licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
link

`deny-licenses`: String?Source

Comma-separated list of forbidden licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")

To set as a Listing, use deny-licenses-list.
link

hidden

`allow-dependencies-licenses-list`: Listing<String>?Source

Comma-separated list of dependencies in purl format (e.g. "pkg:npm/express, pkg:pypi/pycrypto"). These dependencies will be permitted to use any license, no matter what license policy is enforced otherwise.
link

`allow-dependencies-licenses`: String?Source

Comma-separated list of dependencies in purl format (e.g. "pkg:npm/express, pkg:pypi/pycrypto"). These dependencies will be permitted to use any license, no matter what license policy is enforced otherwise.

To set as a Listing, use allow-dependencies-licenses-list.
link

hidden

`allow-ghsas-list`: Listing<String>?Source

Comma-separated list of allowed GitHub Advisory IDs (e.g. "GHSA-abcd-1234-5679, GHSA-efgh-1234-5679")
link

`allow-ghsas`: String?Source

Comma-separated list of allowed GitHub Advisory IDs (e.g. "GHSA-abcd-1234-5679, GHSA-efgh-1234-5679")

To set as a Listing, use allow-ghsas-list.
link

`external-repo-token`: String?Source

A token for fetching external configuration file if it lives in another repository. It is required if the repository is private
link

`license-check`: Boolean?Source

A boolean to determine if license checks should be performed
link

`vulnerability-check`: Boolean?Source

A boolean to determine if vulnerability checks should be performed
link

`comment-summary-in-pr`: ("always"|"never"|"on-failure")?Source

Determines if the summary is posted as a comment in the PR itself. Setting this to always or on-failure requires you to give the workflow pull-requests: write permissions
link

hidden

`deny-packages-list`: Listing<String>?Source

A comma-separated list of package URLs to deny (e.g. "pkg:npm/express, pkg:pypi/pycrypto"). If version specified, only deny matching packages and version; else, deny all regardless of version.
link

`deny-packages`: String?Source

A comma-separated list of package URLs to deny (e.g. "pkg:npm/express, pkg:pypi/pycrypto"). If version specified, only deny matching packages and version; else, deny all regardless of version.

To set as a Listing, use deny-packages-list.
link

hidden

`deny-groups-list`: Listing<String>?Source

A comma-separated list of package URLs for group(s)/namespace(s) to deny (e.g. "pkg:npm/express/, pkg:pypi/pycrypto/"). Please note that the group name must be followed by a /.
link

`deny-groups`: String?Source

A comma-separated list of package URLs for group(s)/namespace(s) to deny (e.g. "pkg:npm/express/, pkg:pypi/pycrypto/"). Please note that the group name must be followed by a /.

To set as a Listing, use deny-groups-list.
link

`retry-on-snapshot-warnings`: Boolean?Source

Whether to retry on snapshot warnings
link

`retry-on-snapshot-warnings-timeout`: Int?Source

Number of seconds to wait before stopping snapshot retries.
link

`warn-only`: Boolean?Source

When set to true this action will always complete with success, overriding the fail-on-severity parameter.
link

`show-openssf-scorecard`: Boolean?Source

Show a summary of the OpenSSF Scorecard scores.
link

`warn-on-openssf-scorecard-level`: Int?Source

Numeric threshold for the OpenSSF Scorecard score. If the score is below this threshold, the action will warn you.
link

`show-patched-versions`: Boolean?Source

When set to true, the vulnerability summary table will include a column showing the first patched version for each vulnerability.

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.