pontil/core

Gleaming GitHub Actions

pontil | ˈpɒntɪl | (punty | ˈpʌnti |) noun
(in glass-making) an iron rod used to hold or shape soft glass.

pontil/core is a port of core functionality from the GitHub actions/toolkit to Gleam. This targets both JavaScript and the BEAM. This library is intended to be used by a higher-level API surface and its use directly is discouraged.

Types

AnnotationProperties

</>

Optional properties that can be sent with output annotation commands (notice, error, and warning). See create a check run for more information about annotations.

pub type AnnotationProperties =
  command.AnnotationProperties

ExitCode

</>

The exit code for an action.

pub type ExitCode =
  command.ExitCode

InputOptions

</>

Options for reading input values in an action.

pub type InputOptions =
  command.InputOptions

PontilCoreError

</>

Errors returned by pontil_core functions.

pub type PontilCoreError =
  command.PontilCoreError

Values

add_path

</>

pub fn add_path(
  input_path: String,
) -> Result(Nil, command.PontilCoreError)

Prepends input_path to the PATH (for this action and future actions).

debug

</>

pub fn debug(message: String) -> Nil

Writes debug message to user log.

describe_error

</>

pub fn describe_error(error: command.PontilCoreError) -> String

Returns a human-readable description of a pontil/core error.

error

</>

pub fn error(message: String) -> Nil

Adds an error issue.

error_annotation

</>

pub fn error_annotation(
  msg message: String,
  props props: List(command.AnnotationProperties),
) -> Nil

Adds an error issue with annotation options.

export_variable

</>

pub fn export_variable(
  name name: String,
  value value: String,
) -> Result(Nil, command.PontilCoreError)

Sets env variable for this action and future actions in the job.

get_boolean_input

</>

pub fn get_boolean_input(
  name: String,
) -> Result(Bool, command.PontilCoreError)

Gets the input value of the boolean type in the YAML 1.2 “core schema” specification. Supported boolean values are true, True, TRUE, false, False, or FALSE.

get_boolean_input_opts

</>

pub fn get_boolean_input_opts(
  name name: String,
  opts opts: List(command.InputOptions),
) -> Result(Bool, command.PontilCoreError)

Gets the input value of the boolean type in the YAML 1.2 “core schema” specification. Supported boolean values are true, True, TRUE, false, False, or FALSE.

get_input

</>

pub fn get_input(name: String) -> String

Gets a GitHub Action input value with default options.

get_input_opts

</>

pub fn get_input_opts(
  name name: String,
  opts opts: List(command.InputOptions),
) -> Result(String, command.PontilCoreError)

Gets a GitHub Action input value with provided options.

get_multiline_input

</>

pub fn get_multiline_input(name: String) -> List(String)

Gets the values of a multiline input with default options. Each value is also trimmed.

get_multiline_input_opts

</>

pub fn get_multiline_input_opts(
  name name: String,
  opts opts: List(command.InputOptions),
) -> Result(List(String), command.PontilCoreError)

Gets the values of a multiline input with provided options.

get_state

</>

pub fn get_state(name: String) -> String

Gets the value of state set by this action’s main execution.

group

</>

pub fn group(name name: String, do action: fn() -> a) -> a

Wraps an action function in an output group.

group_end

</>

pub fn group_end() -> Nil

End an output group.

group_start

</>

pub fn group_start(name: String) -> Nil

Begin an output group.

info

</>

pub fn info(message: String) -> Nil

Writes info to log.

is_debug

</>

pub fn is_debug() -> Bool

Gets whether Actions Step Debug is on or not.

notice

</>

pub fn notice(message: String) -> Nil

Adds a notice issue.

notice_annotation

</>

pub fn notice_annotation(
  msg message: String,
  props props: List(command.AnnotationProperties),
) -> Nil

Adds a notice issue with annotation options.

save_state

</>

pub fn save_state(
  name name: String,
  value value: String,
) -> Result(Nil, command.PontilCoreError)

Saves state for current action, the state can only be retrieved by this action’s post job execution.

set_command_echo

</>

pub fn set_command_echo(enabled: Bool) -> Nil

Enable or disable the echoing of commands into stdout for the rest of the step.

set_exit_code

</>

pub fn set_exit_code(value: command.ExitCode) -> Nil

Sets the action exit code.

set_failed

</>

pub fn set_failed(message: String) -> Nil

Writes the message as an error and sets the action status to failed.

set_output

</>

pub fn set_output(
  name name: String,
  value value: String,
) -> Result(Nil, command.PontilCoreError)

Sets the value of an output for passing values between steps or jobs.

set_secret

</>

pub fn set_secret(secret: String) -> String

Registers a secret which will get masked from logs.

Returns the input value so it can be used as the last expression in a pipeline:

Ok(set_secret("mypassword")) // => Ok("mypassword")

to_platform_path

</>

pub fn to_platform_path(path: String) -> String

Converts the given path to the platform-specific form.

to_posix_path

</>

pub fn to_posix_path(path: String) -> String

Converts the given path to posix form (\\ → /).

to_win32_path

</>

pub fn to_win32_path(path: String) -> String

Converts the given path to win32 form (/ → \\).

warning

</>

pub fn warning(message: String) -> Nil

Adds a warning issue.

warning_annotation

</>

pub fn warning_annotation(
  msg message: String,
  props props: List(command.AnnotationProperties),
) -> Nil

Adds a warning issue with annotation options.