github

Documentation

Overview

Package github builds GitHub Actions workflow-command annotations - the ::error/::warning/::notice lines a workflow parses from a step's output to surface a message inline on a pull request.

Index

• func Error(file string, line int, msg string) string
• func Notice(file string, line int, msg string) string
• func Warning(file string, line int, msg string) string

Functions

func Error

func Error(file string, line int, msg string) string

Error returns an ::error workflow annotation locating msg at file:line. An empty file omits the location; a non-positive line omits just the line. file and msg are escaped per the workflow-command grammar. The result carries no trailing newline.

func Notice

func Notice(file string, line int, msg string) string

Notice returns a ::notice workflow annotation; see Error.

func Warning

func Warning(file string, line int, msg string) string

Warning returns a ::warning workflow annotation; see Error.