Documentation
¶
Overview ¶
Package summary writes to the GitHub Actions job summary.
What a run produced is written here as well as into its pull requests, so that it can be read from the run when someone needs to.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 (*Writer) Problems ¶ added in v0.0.9
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.
func (*Writer) Progress ¶ added in v0.0.26
Progress writes how far the registry has got.
A run is read for what it generated, which says nothing about how much is left. The backfill is the whole of what the registry is doing for now, and this is the only place the numbers exist: the repository can be counted for branches, and the turns each package has had are in the state and nowhere else.
func (*Writer) Renames ¶ added in v0.0.20
Renames writes the repositories the sweep found have been renamed.
The sweep asks every repository what it is called, and GitHub answers a query made with an old name, so this costs nothing to find out. Nothing is done about it yet: the branch holding a package's generated versions is named after the name the registry has, and moving it is a run of its own.
Written where the run is read rather than left in the log, because it is the registry being out of date about what a package is. That stays true until somebody acts on it, and a line in a log nobody reads is how it would stay that way.
Source Files