Packages > pkg.pkl-lang.org/pkl-pantry/pkl.github.dependabotManagedActions

pkl.github.dependabotManagedActions.DependabotManagedActions1.0.2

Overview
Properties
Methods

module pkl.github.dependabotManagedActions.DependabotManagedActions

A template for writing GitHub Actions workflows, whose actions are pinned to specific SHAs, and updated by dependabot.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.github.dependabotManagedActions@1.0.2#/DependabotManagedActions.pkl
Source code:: DependabotManagedActions.pkl
Known subtypes in package:
Known usages in package:
All versions:

Typically, this module is placed in .github/index.pkl. To produce output, the -m (or --multiple-file-output-path) flag must pointed at the repo's .github directory.

In addition to the regular workflows, this template also produces a fake workflow called __lockfile__.yml. The contents of this lockfile are used to replace the uses of versioned actions with their git SHA. For example, uses: checkout@v6 becomes uses: checkout@abc123 # v6. If the lockfile doesn't already exist, or if a new action is used, action versions are resolved to their SHA and the lockfile is updated as a result of evaluation.

Additionally, this template produces a dependabot.yml file, which configures GitHub to automatically update the workflow YAMLs with updated git shas as new action versions are released.

Example

Here is an example of this template in use, along with the corresponding PklProject. In addition to these two files, the project must be resolved with pkl project resolve .github/, which will create .github/PklProject.deps.json to also be checked into the repo.

To render this into YAML, run pkl eval --project-dir .github .github/index.pkl.

// .github/index.pkl
amends "@pkl.github.dependabotManagedActions/DependabotManagedActions.pkl"

import "@com.github.actions/catalog.pkl"

workflows {
  ["workflows/build.yml"] {
    jobs {
      ["do-build"] {
        catalog.`actions/checkout@v6`
        catalog.`actions/setup-go@v5`
        new {
          run = "go test ./..."
        }
      }
    }
  }
}

// .github/PklProject
amends "pkl:Project"

dependencies {
  ["com.github.actions"] {
    uri = "package://pkg.pkl-lang.org/pkl-pantry/com.github.actions@1.3.0"
  }
  ["pkl.github.dependabotManagedActions"] {
    uri = "package://pkg.pkl-lang.org/pkl-pantry/pkl.github.dependabotManagedActions@1.0.0"
  }
}

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
workflows: Mapping<String, Workflow>Source

The effective workflows produced by this job, keyed by the workflow filename.
Example:
```
workflows {
  ["workflow/prb.yml"] = myPrbWorkflow
}
```
link

dependabot: Dependabot Source

Dependabot configuration.

The github-actions ecosystem will be automatically added to this.

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