Documentation
¶
Overview ¶
Package appid is what the three sorts of GitHub App share: one id space.
A GitHub App is one kind of record in storage layout v5 (ADR 0072), keyed by its id, with a purpose: the App that links a person's GitHub account (id `link`), a catalogue App an operator declares (its own id), or the App a self-hosted runner tier registers with in one organisation (id `runner-<tier>-<org>`). The purpose is also what makes the ids disjoint, so the rules that keep them apart are here and nowhere else.
Index ¶
Constants ¶
const LinkID = "link"
LinkID is the id of the link App, of which there is at most one.
const (
MaxLabels = 16
)
Limits on the labels of an App.
const RunnerPrefix = "runner-"
RunnerPrefix begins the id of every runner App.
Variables ¶
var ErrReserved = errors.New("appid: the id is reserved")
ErrReserved is a catalogue App named like an App of another purpose.
Functions ¶
func CheckCatalogueID ¶
CheckCatalogueID refuses an id a catalogue App may not have: the link App's, and any that begins with the runner Apps' prefix.
func CheckLabels ¶
CheckLabels refuses labels that are too many, or whose key or value is not a short lower-case name. A label has a key and may have an empty value.
Source Files