Pkldoc > com.github.action > com.github.action.actions.Artifact

UploadInputs0.0.7

Properties
Methods

class UploadInputs

Known subtypes:
Known usages:
All versions:

Properties

link

name: String?

Name of the artifact to upload.

Optional. Default is 'artifact'
link

path: String

A file, directory or wildcard pattern that describes what to upload
link
`if-no-files-found`: ("warn"|"error"|"ignore")?

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
Optional. Default is 'warn'
link

`retention-days`: Int?

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.

Optional. Defaults to repository settings.
link

`compression-level`: Int(isBetween(0, 9))?

The level of compression for Zlib to be applied to the artifact archive.

The value can range from 0 to 9. For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads. Optional. Default is '6'
link

overwrite: Boolean?

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.

Optional. Default is 'false'
link

`include-hidden-files`: Boolean?

Whether to include files in the provided path in the artifact.

The file contents of any files in the path should be validated before enabled this to avoid uploading sensitive information.

Optional. Default is 'false'

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.