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

com.github.actions.Action1.3.0

Overview
Properties
Methods
Classes

module com.github.actions.Action

The action metadata, to be placed as action.yml in a repository.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.github.actions@1.3.0#/Action.pkl
Source code:: Action.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

name: String Source

The name of your action.

GitHub displays the name in the Actions tab to help visually identify actions in each job.
link

author: String?Source

The name of the action's author.
link

description: String Source

A short description of the action.
link

inputs: Mapping<String(matches(Regex("^[_a-zA-Z][a-zA-Z0-9_-]*$"))), Input>?Source

Input parameters allow you to specify data that the action expects to use during runtime.

GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.
link

outputs: Mapping<String(matches(Regex("^[_a-zA-Z][a-zA-Z0-9_-]*$"))), Output((value != null).implies(runs is RunsComposite))>?Source

Output parameters allow you to declare data that an action sets.

Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. Outputs can be a maximum of 1 MB per job. The total of all outputs in a workflow run can be a maximum of 50 MB. Size is approximated based on UTF-16 encoding. If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. For more information on setting outputs in an action, see Workflow commands for GitHub Actions.
link

runs: RunsJavascript|RunsComposite|RunsDocker Source

Specifies whether this is a JavaScript action, a composite action, or a Docker container action and how the action is executed.
link

branding: Branding?Source

You can use a color and Feather icon to create a badge to personalize and distinguish your action.

Badges are shown next to your action name in GitHub Marketplace.

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

link

class

Input Source

A string identifier to associate with the input.
link

class

Output Source
link

class

Branding Source

You can use a color and Feather icon to create a badge to personalize and distinguish your action.
link

class

RunsJavascript Source

Configures the path to the action's code and the application used to execute the code.
link

class

RunsComposite Source

Configures the path to the composite action, and the application used to execute the code.
link

class

Step Source
link

class

RunsDocker Source

Configures the image used for the Docker action.