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

com.github.actions.contrib.ActionGenerator1.0.3

Overview
Properties
Methods
Type Aliases

module com.github.actions.contrib.ActionGenerator

Utility library for generating a TypedStep given an action definition.

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

Example:

import "@com.github.actions.contrib/ActionGenerator.pkl"

local generator: ActionGenerator = new { actionName = "actions/checkout@v5" }

// The resulting action's Pkl source code, in text form.
local generatedActionPkl = generator.result

CLI usage

There is a helper to generate this action from the CLI; see generate-action.pkl.

Using within a project

If generating a package within a project, the githubActionsPackageName property needs to be set. This needs to be the simple name of the dependency that maps to package coordinate package://pkg.pkl-lang.org/pkl-pantry/com.github.actions.

For example:

import "@com.github.actions.contrib/ActionGenerator.pkl"

local generator: ActionGenerator = new {
  actionName = "actions/checkout@v5"
  githubActionsPackageName = "com.github.actions"
}

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 to be generated.

Example: "actions/checkout@v4"
link

action: Action?Source

The action definition to generate

If null, will read and parse from GitHub, based on actionName.
link

actionTypes: ActionTypes?Source

The specific type for each action input.

If null, will try to read from the repo's action-types.yml file, or from https://github.com/typesafegithub/github-actions-typing-catalog, based on actionName.
link

discoverActionTypes: Boolean Source

Whether to discover action types, if actionTypes is null.
link

adjustments: Mapping<String, Mixin<PropertyDefinitionNode>>?Source

Any adjustments that need to be made to the generated With class.
link

moduleNamePrefix: String?Source

A prefix name to add to the module
link

pathPrefix: String?Source

A path prefix to add to the module
link

githubActionsPackageName: String Source

The name of the GitHub actions package.
link

moduleName: unknownSource
link

inputsName: unknownSource
link

modulePath: Listing<String>Source
link

moduleNode: ModuleNode Source
link

result: unknownSource

The resulting Pkl code from generating this action.

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

Type Aliases

link

typealias

ActionName = String(matches(actionNameRegex))Source