Derive a public news page and one release-notes page per component version from CHANGELOG.archied.md and CHANGELOG.archie.md, the notes the release process already freezes. - tools/newsgen writes docs/news/releases.json, the canonical artifact a host renders from, plus the MkDocs pages. Check mode fails when the committed files lag a changelog edit, and runs in task check; tools/release.sh --tag regenerates and stages them in the release commit, skipping files already current. - mkdocs.yml keeps the version pages out of the derived navigation without excluding them from the site.
146 lines
3.8 KiB
Go
146 lines
3.8 KiB
Go
package main
|
|
|
|
import (
|
|
"encoding/json"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
func sampleReleases() []release {
|
|
return []release{
|
|
{Component: "archied", Name: "archied", Version: "1.31.0", Date: "2026-09-22", Body: "### Gateway\n\n- a bullet"},
|
|
{Component: "archie", Name: "archie-agent", Version: "1.31.0", Date: "2026-09-22", Body: "- a runtime bullet"},
|
|
{Component: "archied", Name: "archied", Version: "1.30.0", Date: "2026-09-20", Body: "Prose."},
|
|
}
|
|
}
|
|
|
|
func TestRenderEmitsTheCanonicalJSON(t *testing.T) {
|
|
files, err := render(sampleReleases())
|
|
if err != nil {
|
|
t.Fatalf("render error = %v", err)
|
|
}
|
|
body, ok := files[releasesJSONPath]
|
|
if !ok {
|
|
t.Fatalf("render produced no %s (files: %v)", releasesJSONPath, keys(files))
|
|
}
|
|
var decoded []release
|
|
if err := json.Unmarshal(body, &decoded); err != nil {
|
|
t.Fatalf("canonical JSON does not decode into []release: %v", err)
|
|
}
|
|
if !reflect.DeepEqual(decoded, sampleReleases()) {
|
|
t.Fatalf("round trip = %+v, want %+v", decoded, sampleReleases())
|
|
}
|
|
}
|
|
|
|
func TestRenderJSONKeepsHTMLCharactersReadable(t *testing.T) {
|
|
releases := []release{{
|
|
Component: "archied", Name: "archied", Version: "1.0.0", Date: "2026-01-01",
|
|
Body: "a -> b and <memory>",
|
|
}}
|
|
files, err := render(releases)
|
|
if err != nil {
|
|
t.Fatalf("render error = %v", err)
|
|
}
|
|
got := string(files[releasesJSONPath])
|
|
for _, want := range []string{"a -> b", "<memory>"} {
|
|
if !strings.Contains(got, want) {
|
|
t.Fatalf("canonical JSON escaped %q:\n%s", want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRenderWritesOnePagePerComponentVersion(t *testing.T) {
|
|
files, err := render(sampleReleases())
|
|
if err != nil {
|
|
t.Fatalf("render error = %v", err)
|
|
}
|
|
for _, path := range []string{
|
|
"docs/news/index.md",
|
|
"docs/news/archied/1.31.0.md",
|
|
"docs/news/archie/1.31.0.md",
|
|
"docs/news/archied/1.30.0.md",
|
|
} {
|
|
if _, ok := files[path]; !ok {
|
|
t.Fatalf("render did not produce %s (files: %v)", path, keys(files))
|
|
}
|
|
}
|
|
if len(files) != 5 {
|
|
t.Fatalf("render produced %d files, want 5: %v", len(files), keys(files))
|
|
}
|
|
}
|
|
|
|
func TestRenderIndexGroupsByDate(t *testing.T) {
|
|
files, err := render(sampleReleases())
|
|
if err != nil {
|
|
t.Fatalf("render error = %v", err)
|
|
}
|
|
want := `# News
|
|
|
|
Release notes for archied and archie-agent, newest first.
|
|
|
|
## 2026-09-22
|
|
|
|
- [archied 1.31.0](archied/1.31.0.md)
|
|
- [archie-agent 1.31.0](archie/1.31.0.md)
|
|
|
|
## 2026-09-20
|
|
|
|
- [archied 1.30.0](archied/1.30.0.md)
|
|
`
|
|
if got := string(files["docs/news/index.md"]); got != want {
|
|
t.Fatalf("index markdown =\n%s\nwant\n%s", got, want)
|
|
}
|
|
}
|
|
|
|
func TestRenderReleasePageKeepsTheBodyVerbatim(t *testing.T) {
|
|
files, err := render(sampleReleases())
|
|
if err != nil {
|
|
t.Fatalf("render error = %v", err)
|
|
}
|
|
want := `# archie-agent 1.31.0
|
|
|
|
Released 2026-09-22. [All news](../index.md)
|
|
|
|
- a runtime bullet
|
|
`
|
|
if got := string(files["docs/news/archie/1.31.0.md"]); got != want {
|
|
t.Fatalf("release page =\n%s\nwant\n%s", got, want)
|
|
}
|
|
}
|
|
|
|
func TestRenderIsDeterministic(t *testing.T) {
|
|
first, err := render(sampleReleases())
|
|
if err != nil {
|
|
t.Fatalf("first render error = %v", err)
|
|
}
|
|
second, err := render(sampleReleases())
|
|
if err != nil {
|
|
t.Fatalf("second render error = %v", err)
|
|
}
|
|
if !reflect.DeepEqual(first, second) {
|
|
t.Fatal("two renders of the same releases differ")
|
|
}
|
|
}
|
|
|
|
func TestRenderHandlesNoReleases(t *testing.T) {
|
|
files, err := render(nil)
|
|
if err != nil {
|
|
t.Fatalf("render error = %v", err)
|
|
}
|
|
if got := string(files[releasesJSONPath]); got != "[]\n" {
|
|
t.Fatalf("empty canonical JSON = %q, want %q", got, "[]\n")
|
|
}
|
|
if got := string(files["docs/news/index.md"]); got != "# News\n\nRelease notes for archied and archie-agent, newest first.\n" {
|
|
t.Fatalf("empty index = %q", got)
|
|
}
|
|
}
|
|
|
|
func keys(m map[string][]byte) []string {
|
|
out := make([]string, 0, len(m))
|
|
for k := range m {
|
|
out = append(out, k)
|
|
}
|
|
return out
|
|
}
|