pontil/summary

Hex.pm Hex Docs Apache 2.0 JavaScript Compatible Erlang Compatible

Pontil summary implements the functionality of actions/core summary, which builds job summary output for GitHub Actions output, and is ported from the GitHub Actions toolkit.

pontil_summary works with all Gleam targets and runtimes.

Usage

gleam add pontil_summary@1
import pontil/summary

pub fn main() {
  summary.new()
  |> summary.h2("Test Results")
  |> summary.raw("<b>All tests passed.</b>")
  |> summary.append()
}

Function Portability

All public functions are annotated as either {portable} or {actions}. The former are usable with any Gleam program while the latter assume that the Gleam program is being run in a GitHub Actions (or compatible) environment. For pontil/summary, only summary.append, summary.overwrite, and summary.clear are Actions-only.

Semantic Versioning

Pontil summary follows Semantic Versioning 2.0.

Search Document