folding

package
v1.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2025 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package folding provides a way to fold / collapse log messages when it detects it's running in a CI environment'

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Folder

type Folder interface {
	Start(file string, msg string, open bool) (string, error)
	Stop(id string) error
}

Folder represents a CI environment that supports folding / collapsing log messages

func New

func New() Folder

New returns a Folding instance based on if a CI environment variable is set

func NewGithub

func NewGithub(w io.Writer) Folder

NewGithub uses the GitHub Actions log syntax

func NewGitlab

func NewGitlab(w io.Writer) Folder

NewGitlab uses the Gitlab CI log syntax

func NewPlain

func NewPlain(w io.Writer) Folder

NewPlain is a basic implementation of the Folder interface

func NewW

func NewW(w io.Writer) Folder

NewW returns a Folding instance based on a custom writer

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL