com.github.action.Action0.0.5

Overview
Properties
Methods

module com.github.action.Action

Prebuild GitHub Actions in a typed way. Use them to eliminate boilerplate code in your plk workflows.

Module URI:: package://pkg.pkl-lang.org/github.com/stefma/pkl-gha/com.github.action@0.0.5/Action.pkl
Pkl version:: 0.25.3 or higher
Known subtypes:
Known usages:
All versions:

Example:

steps {
  (Actions.checkout) {
    fetchDepth = 0
    token = Context.secrets("CUSTOM_PAT")
  }
  (Actions.setupGo) {
    goVersion = "1.20.2"
   }
}

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

checkout: Checkout
link

addToProject: AddToProject
link

gitHubScript: GitHubScript
link

labeler: Labeler
link

deletePackageVersion: DeletePackageVersion
link

stale: Stale
link

dependencyReviewAction: DependencyReviewAction
link

goDependencySubmission: GoDependencySubmission
link

attestSbom: AttestSbom
link

aiInference: AiInference
link

createGitHubAppToken: CreateGitHubAppToken
link

downloadArtifact: Download
link

uploadArtitact: Upload
link

uploadArtifactMerge: UploadArtifactMerge
link

configurePages: Configure
link

uploadPagesArtifact: UploadArtifact
link

jekyllBuildPages: JekyllBuild
link

deployPages: Deploy
link

cache: Cache
link

cacheSave: Save
link

cacheRestore: Restore
link

setupGo: Go
link

setupNode: Node
link

setupPython: Python
link

setupJava: Java

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