summary

package
v0.0.19 Latest Latest
Warning

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

Go to latest
Published: Sep 26, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package summary writes to the GitHub Actions job summary.

registry.json is stored on one line: nothing reads it by eye, and the indentation is 30% of the bytes every aqua user downloads while costing nothing in the repository, where git compresses it away. The indented form is written here instead, so that what a run produced can still be read when someone needs to.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Problem added in v0.0.9

type Problem struct {
	Package string
	Version string
	Reason  string
}

Problem is a version a run didn't publish, and why.

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer appends to the job summary. A Writer with no path does nothing, which is what happens outside GitHub Actions.

func New

func New() *Writer

New creates a Writer for the current job.

func (*Writer) Add

func (w *Writer) Add(pkgName string, versions map[string]any) error

Add writes one package's generated files to the summary, indented.

func (*Writer) Problems added in v0.0.9

func (w *Writer) Problems(problems []*Problem) error

Problems writes what the run couldn't publish.

A version whose signature can't be verified isn't published, and the next run tries it again, so a release that has genuinely stopped being signed produces nothing but a line in a log nobody reads. Here it is where the run is read.

It is written whatever the summary already holds. The budget the generated files spend is under what GitHub accepts, and this is the part worth keeping when they have used the rest.

Jump to

Keyboard shortcuts

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