Documentation
¶
Overview ¶
Package release tracks which version of jaira last prepared a board, and carries the change notes a user reads when a newer binary catches up an older one.
The notes are never copied to disk anywhere: a copy can drift from the binary that reads it, but the binary always knows what is in itself. So the notes are embedded with go:embed and read straight out of the executable.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Current = "dev"
Current is the version of the running binary. It is a package-level var, set once by cli.Execute, because the TUI also creates boards and plumbing a version string through the whole TUI to stamp one file is not worth it.
Functions ¶
Types ¶
type Entry ¶
Entry is one release's worth of change notes.
func Notes ¶
func Notes() []Entry
Notes parses the embedded NOTES.md, newest release first, in file order.
func Since ¶
Since returns the entries newer than stamped, selecting by position in the notes file rather than by parsing version numbers. A stamp that appears nowhere in the file — empty, "dev", a snapshot build, or a version older than the oldest entry — cannot be reasoned about any other way, so it selects everything. Showing too much on an unknown stamp is the safe direction; showing too little is not.
Source Files