Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.upload-artifact.v7.UploadArtifact

With1.8.0

Properties
Methods

class With

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

Properties

link

name: String?Source

Artifact name. If the archive input is false, the name of the file uploaded will be the artifact name.

Default if unspecified: "artifact"
link

hidden

pathList: Listing<String>Source

A file, directory or wildcard pattern that describes what to upload.
link

path: String Source

A file, directory or wildcard pattern that describes what to upload.

To set as a Listing, use pathList.
link

`if-no-files-found`: ("warn"|"error"|"ignore")?Source

The desired behavior if no files are found using the provided path. Available Options: warn: Output a warning but do not fail the action error: Fail the action with an error message ignore: Do not output any warnings or errors, the action does not fail

Default if unspecified: "warn"
link

`retention-days`: Int?Source

Duration after which artifact will expire in days. 0 means using default retention. Minimum 1 day. Maximum 90 days unless changed from the repository settings page.
link

`compression-level`: Int?Source

The level of compression for Zlib to be applied to the artifact archive. The value can range from 0 to 9: - 0: No compression - 1: Best speed - 6: Default compression (same as GNU Gzip) - 9: Best compression Higher levels will result in better compression, but will take longer to complete. For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.

Default if unspecified: "6"
link

overwrite: Boolean?Source

If true, an artifact with a matching name will be deleted before a new one is uploaded. If false, the action will fail if an artifact for the given name already exists. Does not fail if the artifact does not exist.

Default if unspecified: "false"
link

`include-hidden-files`: Boolean?Source

If true, hidden files will be included in the artifact. If false, hidden files will be excluded from the artifact.

Default if unspecified: "false"
link

archive: Boolean?Source

If true, the artifact will be archived (zipped) before uploading. If false, the artifact will be uploaded as-is without archiving. When archive is false, only a single file can be uploaded. The name of the file will be used as the artifact name (ignoring the name parameter).

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.