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

com.github.actions.Container1.3.0

Overview
Properties
Methods
Classes

module com.github.actions.Container

Use jobs.<job_id>.container to create a container to run any steps in a job that don't already specify a container.

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

credentials: Credentials?Source

If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password.

The credentials are the same values that you would provide to the docker login command.
link

env: EnvironmentVariables?Source

Sets an array of environment variables in the container.
link

image: String Source

The Docker image to use as the container to run the action.

The value can be the Docker Hub image name or a registry name.
link

options: String?Source

Additional Docker container resource options.

For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.
link

ports: Listing<(UInt16|String)>(!isEmpty)?Source

Sets an array of ports to expose on the container.
link

volumes: Listing<String>(!isEmpty)?Source

Sets an array of volumes for the container to use.

You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. To specify a volume, you specify the source and destination path: : The is a volume name or an absolute path on the host machine, and is an absolute path in the container.

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

Credentials Source