githubactions

Documentation

Index

• func EscapeSummaryText(text string) string
• func EscapeWorkflowCommandMessage(message string) string
• func EscapeWorkflowCommandProperty(value string) string
• func SummaryCode(text string) string
• func SummaryLink(target, label string) string
• func WriteAnnotations(output io.Writer, annotations []Annotation)
• func WriteSummaryFromEnv(logOutput io.Writer, sections []SummarySection)
• type Annotation
• type SummarySection

Functions

func EscapeSummaryText

func EscapeSummaryText(text string) string

EscapeSummaryText escapes user-controlled text for safe single-line HTML rendering in a GitHub step summary.

func EscapeWorkflowCommandMessage

func EscapeWorkflowCommandMessage(message string) string

EscapeWorkflowCommandMessage escapes data written after the second :: in a GitHub Actions workflow command.

func EscapeWorkflowCommandProperty

func EscapeWorkflowCommandProperty(value string) string

EscapeWorkflowCommandProperty escapes a workflow command property value such as a file path.

func SummaryCode

func SummaryCode(text string) string

SummaryCode renders a single-line string as HTML code in a GitHub step summary.

func SummaryLink

func SummaryLink(target, label string) string

SummaryLink renders a single-line hyperlink in a GitHub step summary.

func WriteAnnotations

func WriteAnnotations(output io.Writer, annotations []Annotation)

WriteAnnotations emits GitHub Actions workflow command annotations so findings surface in the PR diff view and workflow logs.

func WriteSummaryFromEnv

func WriteSummaryFromEnv(logOutput io.Writer, sections []SummarySection)

WriteSummaryFromEnv appends the provided summary sections to the GitHub step summary file when GITHUB_STEP_SUMMARY is available.

Types

type Annotation

type Annotation struct {
	Level   string
	File    string
	Line    int
	Message string
}

Annotation is one GitHub Actions workflow command annotation.

type SummarySection

type SummarySection struct {
	Heading string
	Items   []string
}

SummarySection is one titled block in a GitHub Actions step summary.