Documentation
¶
Overview ¶
Package motd implements the "message of the day" mechanism: a small always-on banner that the daemon polls from a static JSON feed and mirrors to a local file, and that pilotctl prepends to every command's output.
The split of responsibilities is deliberate:
- The daemon is the ONLY component that touches the network. A background loop fetches the feed on an interval, picks the entry active for the current UTC day, and writes it to the local mirror.
- pilotctl only ever reads the mirror — one local file read, no HTTP, no IPC — so every command stays fast and works even if the daemon is momentarily unreachable.
Clearing is a first-class operation: an empty feed, a feed with no entry for today, or a feed the operator emptied on purpose all resolve to a cleared mirror, so the banner disappears on its own within one poll interval.
Index ¶
Constants ¶
const ( // DefaultFeedURL is the canonical message-of-the-day source: the raw // contents of feed-motd.json on the pilot-changelog repo's default // branch. That feed is the `scope: motd` per-scope output of the // changelog render pipeline — each entry's `date` is the UTC day the // banner is active and its `title` is the banner text. Publishing or // clearing a motd entry there propagates to every daemon on its next // poll (subject to GitHub's raw CDN cache, typically a few minutes). DefaultFeedURL = "https://raw.githubusercontent.com/pilot-protocol/pilot-changelog/main/feed-motd.json" // DefaultInterval is how often the daemon re-fetches the feed when no // interval is configured. DefaultInterval = 15 * time.Minute // SchemaVersion is the feed schema this build understands. A feed may // omit the field (treated as compatible); a feed that declares a // different non-zero version is rejected. SchemaVersion = 1 )
Variables ¶
This section is empty.
Functions ¶
func ReadActiveMirror ¶
ReadActiveMirror reads the local mirror and returns the banner text active for the UTC day of now. It returns ("", false) when the file is absent, empty, malformed, blank, or dated for a day other than today — so a stale mirror (e.g. the daemon was offline across a UTC midnight) never shows yesterday's message. This is the only function pilotctl calls on the hot path: a single local file read, no network.
func WriteMirror ¶
WriteMirror atomically writes the active message to path. Passing a message with blank Text writes a cleared mirror (so a reader can tell "checked, nothing today" from "never written"). now stamps UpdatedAt. The parent directory is created if missing.
Types ¶
type Feed ¶
Feed is the on-the-wire shape served at the feed URL — the pilot-changelog per-scope feed (feed-motd.json). Only the fields the daemon needs are decoded; everything else (scope, visibility, body, excerpt, …) is ignored.
type Message ¶
type Message struct {
Date string `json:"date"` // UTC calendar day, "YYYY-MM-DD"
Text string `json:"title"`
ID string `json:"id,omitempty"`
}
Message is a single dated message-of-the-day entry. It maps a pilot-changelog feed entry: the entry `date` is the UTC day the banner is active, and the entry `title` is the banner text.
func SelectForToday ¶
SelectForToday returns the message whose Date equals the UTC day of now. The second result is false when no message is active (no entry for today, or its text is blank). When several entries share today's date the first non-blank one wins — operators are expected to keep one per day.
type Mirror ¶
type Mirror struct {
Date string `json:"date"`
Text string `json:"text"`
UpdatedAt time.Time `json:"updated_at"`
}
Mirror is the local materialized "variable" the CLI reads. It holds at most the single message active for Date. An empty Text — or a Date that no longer matches today — means "no banner".
Source Files