generated from mathias/template-go-web
Makes the atlas self-explanatory. Every stage/node gains a plain-language layer (plain_title + plain "what happens" + jargon-free node text); the previous technical copy demotes to a subtitle + on-demand detail. A Plain⇄Technical toggle (default Plain, persisted) flips the whole atlas. Biggest win: every transition arrow is now LABELLED with "what must be true to advance" (the gated- flow story that was invisible), gate hops (human @04, CI @06) styled distinctly. Spine repositioned into a uniform header band so labels never collide with copy. Copy grounded in a fresh-eyes UX review (docs/UX-REVIEW.md, reviewer≠implementer). Data model: plain_title/plain/trans_label/trans on Stage, plain on Node — guarded by a test (every stage has plain_title + a transition). Live overlays unchanged. Verified: build/vet/lint(0)/test green; Plain render screenshot-checked. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
78 lines
2.5 KiB
Go
78 lines
2.5 KiB
Go
package atlas
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
)
|
|
|
|
// Host is a substrate machine/entry (koala, iguana, …).
|
|
type Host struct {
|
|
Name string `json:"n"`
|
|
Spec string `json:"k"`
|
|
}
|
|
|
|
// Node is a card within a stage. Plain is the jargon-free default text; Desc is
|
|
// the technical detail shown on demand.
|
|
type Node struct {
|
|
Title string `json:"t"`
|
|
Plain string `json:"plain,omitempty"`
|
|
Desc string `json:"d,omitempty"`
|
|
Pill string `json:"pill,omitempty"`
|
|
Cls string `json:"cls,omitempty"`
|
|
Tags []string `json:"tags,omitempty"`
|
|
Risk bool `json:"risk,omitempty"`
|
|
Gate bool `json:"gate,omitempty"`
|
|
}
|
|
|
|
// Stage is one column of the pipeline. PlainTitle/Plain are the plain-language
|
|
// default layer; Title/Path/Nodes[].Desc are the technical layer. TransLabel/
|
|
// Trans annotate the outgoing transition (the arrow to the next stage): what
|
|
// moves work forward and what must be true to advance. When Generate is set,
|
|
// Nodes are derived from a live source at Build time.
|
|
type Stage struct {
|
|
No string `json:"no"`
|
|
Title string `json:"title"`
|
|
PlainTitle string `json:"plain_title,omitempty"`
|
|
Plain string `json:"plain,omitempty"`
|
|
Path string `json:"path,omitempty"`
|
|
Cls string `json:"cls,omitempty"`
|
|
Generate string `json:"generate,omitempty"`
|
|
TransLabel string `json:"trans_label,omitempty"`
|
|
Trans string `json:"trans,omitempty"`
|
|
Nodes []Node `json:"nodes"`
|
|
}
|
|
|
|
// Atlas is the full data model the frontend renders.
|
|
type Atlas struct {
|
|
Version string `json:"version,omitempty"`
|
|
Substrate []Host `json:"substrate"`
|
|
NS string `json:"ns,omitempty"`
|
|
Timeline []RunDot `json:"timeline,omitempty"`
|
|
Stages []Stage `json:"stages"`
|
|
}
|
|
|
|
// Build unmarshals the authored atlas JSON and overlays generated facts from
|
|
// real sources, so sourced parts can't drift. Currently: any stage marked
|
|
// `"generate":"ci-jobs"` gets its Nodes replaced by the workflow's job list.
|
|
func Build(atlasJSON, workflow []byte) (Atlas, error) {
|
|
var a Atlas
|
|
if err := json.Unmarshal(atlasJSON, &a); err != nil {
|
|
return Atlas{}, fmt.Errorf("parse atlas data: %w", err)
|
|
}
|
|
for i := range a.Stages {
|
|
if a.Stages[i].Generate != "ci-jobs" {
|
|
continue
|
|
}
|
|
jobs, err := JobsFromWorkflow(workflow)
|
|
if err != nil {
|
|
return Atlas{}, fmt.Errorf("stage %s: %w", a.Stages[i].No, err)
|
|
}
|
|
nodes := make([]Node, 0, len(jobs))
|
|
for _, j := range jobs {
|
|
nodes = append(nodes, Node{Title: j})
|
|
}
|
|
a.Stages[i].Nodes = nodes
|
|
}
|
|
return a, nil
|
|
}
|