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

com.github.actions.contrib.`generate-action`1.0.3

Overview
Properties
Methods

module com.github.actions.contrib.`generate-action`

Generates a typed step that calls out to a GitHub Action.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.github.actions.contrib@1.0.3#/generate-action.pkl
Pkl version:: 0.30.0 or higher
Source code:: generate-action.pkl
Known subtypes in package:
Known usages in package:
All versions:

The types for an action can be enhanced with types from typesafegithub. It will look either at the repo's action-types.yml file, or within github-actions-typing-catalog to determine the corresponding types.

If actions are missing in either of these sources, use the programmatic ActionGenerator instead.

Sample usage:

pkl eval package://pkg.pkl-lang.org/pkl-pantry/com.github.actions.contrib@<VERSION>#/generate-action.pkl \
  -m . \
  -p action-name=actions/checkout@v4

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

actionName: ActionName Source

The name of the action that should be generated.

Should include the version string.
link

files: Mapping<String, FileOutput>Source

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)
```