Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var SupportedPlaceholders = func() []string { names := make([]string, len(placeholders)) for i, p := range placeholders { names[i] = p.name } return names }()
SupportedPlaceholders is the ordered list of every placeholder name accepted in title, body, and string-valued frontmatter. Derived from the placeholders table. Exposed for callers (inventory validators, docs generators) that need the closed-enum list.
Functions ¶
func NewNoopSender ¶
func NewNoopSender() task.CreateCommandSender
NewNoopSender returns a task.CreateCommandSender whose SendCommand method is a no-op (returns nil). Wired by main.go and cmd/run-once when DRY_RUN=true to avoid Kafka client init. The publisher's dryRun guard skips the sender call anyway; the noop exists so the application can construct itself without a real Kafka broker.
Types ¶
type FrontmatterFormatter ¶ added in v0.1.0
type FrontmatterFormatter interface {
// Format returns the frontmatter for one published task. String
// values in `operator` are rendered through the same placeholder
// substitution as title/body (`{{date}}`, `{{iso-week}}`, etc.);
// non-string values (ints, slices, maps) pass through unchanged.
// `slug` and `date` parameterize the placeholder render; `date` is
// the Berlin civil date the task fires for (the publisher converts
// wall-clock once at the tick boundary).
Format(operator lib.TaskFrontmatter, slug string, date schedule.Date) lib.TaskFrontmatter
}
FrontmatterFormatter builds the YAML frontmatter stamped onto every published task. The formatter is the single seam between operator- supplied frontmatter (from `Schedule.spec.template.frontmatter`) and the wire-level `task.CreateCommand.Frontmatter` payload: it seeds published-author defaults, renders placeholder tokens in string values via the publisher's closed placeholder set, merges operator keys (which may override the defaults), and force-sets the provenance key `created_by: recurring-task-creator` last so a Schedule CR cannot impersonate a different author.
func NewFrontmatterFormatter ¶ added in v0.1.0
func NewFrontmatterFormatter(renderer Renderer) FrontmatterFormatter
NewFrontmatterFormatter returns the default FrontmatterFormatter that renders string-valued frontmatter via the injected Renderer (same placeholder semantics as title/body). Stateless: safe to construct once and share across goroutines.
type Publisher ¶
type Publisher interface {
// Publish builds a CreateCommand for (def, date) and sends it. The
// returned error is wrapped with the slug and ISO date in its message.
// Same (def, date) on a second call produces a byte-identical command.
Publish(ctx context.Context, def schedule.TaskDefinition, date schedule.Date) error
}
Publisher turns one (TaskDefinition, Date) pair into a validated task.CreateCommand and sends it via the injected task.CreateCommandSender.
func NewPublisher ¶
func NewPublisher( sender task.CreateCommandSender, renderer Renderer, formatter FrontmatterFormatter, dryRun bool, ) Publisher
NewPublisher returns a Publisher that sends through sender, rendering title + body placeholders via renderer, and formatting frontmatter via formatter. The sender is invoked exactly once per Publish call (when inputs are valid). It validates the constructed command internally — see task.CreateCommandSender.SendCommand in github.com/bborbe/agent/lib/command/task. When dryRun is true, the publisher logs the would-be CreateCommand and skips the sender call (intended for local smoke-testing via cmd/run-once).
type Renderer ¶ added in v0.2.0
type Renderer interface {
// Render returns template with every placeholder substituted by
// its rendered value for date. The slug parameter is reserved for
// future placeholders that depend on the slug itself; the current
// set does not. Pure: no I/O, no time, no state — same inputs on
// a second call produce a byte-identical result.
Render(template, slug string, date schedule.Date) string
}
Renderer substitutes the closed set of `{{...}}` placeholder tokens (see placeholders.go) inside an operator-authored template string. Same seam used by the publisher for title and body rendering and by FrontmatterFormatter for string-valued frontmatter entries — single definition of "what a placeholder is" across every render site.
func NewRenderer ¶ added in v0.2.0
func NewRenderer() Renderer
NewRenderer returns the default Renderer backed by the package-level placeholders table. Stateless: safe to construct once and share across goroutines.
Source Files