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

com.github.actions.context1.3.0

Overview
Properties
Methods
Classes

module com.github.actions.context

Access context information in GitHub Actions workflows in a type safe manner.

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

github: GitHub Source

Information about the workflow run.
link

job: Job Source

Information about the currently running job.
link

jobs: Jobs Source

For reusable workflows only, contains outputs of jobs from the reusable workflow.
link

steps: Steps Source

Information about the steps that have been run in the current job.
link

runner: Runner Source

Information about the runner that is running the current job.
link

strategy: Strategy Source

Information about the matrix execution strategy for the current job.
link

needs: Needs Source

Contains the outputs of all jobs that are defined as a dependency of the current job.

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

function

env(name: String): String Source
link

function

secrets(name: String): String Source
link

function

matrix(propertyName: String): String Source
link

function

inputs(name: String): String Source

Classes

link

class

GitHub Source
link

class

Job Source
link

class

JobServices Source
link

class

Jobs Source
link

class

Steps Source
link

class

Runner Source
link

class

Strategy Source
link

class

Needs Source