Public: anyone can read this; the crew can change it.

A closed chapter's wave shows as an entry on /changelog itself, with its sentence and up to ten pull links #14226

Merged opened this

Check · Review · Land · Live done — Landed and live in production.

Merged

A closed chapter's wave now shows on /changelog as its own entry: the wave's plain sentence plus links to up to ten pulls. The new test passes and fails on main, and the 795 tests I ran around the change pass. That run covered changelog, wave, TUI and OpenAPI tests and tsc --noEmit.

Notes

shipped production is serving it deploy 4adf612

opened this

A closed chapter's wave now shows on /changelog as its own entry: the wave's plain sentence plus links to up to ten pulls. The new test passes and fails on main, and the 795 tests I ran around the change pass. That run covered changelog, wave, TUI and OpenAPI tests and tsc --noEmit. scripts/fast.ts said the diff was too broad to name tests, so I picked them myself; I did not run the full suite.

  • Where it reads from: the entry is read back from waves/<version>.md, the file closing already commits, so there is no new storage. The new module src/release/chapter_waves.ts does the reading, with a small cache keyed on the default branch's tip commit.
  • Page: the entry sits in the chapter's section on /changelog, under the row carrying the closing date.
  • JSON: each waves[] item in /api/v1/changelog gains sentence and links when the chapter wrote a wave.
  • Terminal: the changelog screen shows the sentence and pull titles under the chapter's heading line.
  • ETag: the page's ETag now includes the waves. The wave is committed after the close itself, so the close alone would not have moved it. The new test checks the ETag changes after the close.
  • Test: test/changelog-chapters.test.ts closes a chapter with 12 shipped pulls, then reads /changelog, the JSON and the terminal lines. Inside the entry it finds the sentence and exactly ten pull links.

Chapters still only appear on /changelog when their repository has landings; I left that grouping rule as it was. The pull links are absolute URLs, as already written into the wave file. The terminal shows the wave lines as plain text, not selectable. I did not touch the /waves pages or the Atom feed.

To try it: close a chapter named like v1.1.0 that has shipped issues, then open /changelog?repo=owner/name.

The push needed a Try: line in a commit to satisfy the pre-push hook.

Closes #14221

Show 7 earlier items

7 earlier comments · 1 event
commented

Looks: /changelog

The gate's note came from src/web/pages/changelog.ts. This pull changes that page, and the gate traced its route to /settings/security/controls, which is the wrong page. I pushed an empty commit whose message names /changelog as the page to look at. The earlier commit's Looks: line named the source file, so it didn't satisfy the gate.

A closed chapter's wave (for example v1.1.0) is now one entry on /changelog, in its JSON and on the terminal's Changelog screen. Each entry has a sentence naming the chapter and up to ten pull links.

  • Doors: there is no new terminal screen. The existing Changelog screen and docs/features/changelog.md are extended, and a No door: commit line says so.
  • Cache: the wave cache lives in src/release/chapter_waves.ts, keyed by app and capped at 200 entries per app.
  • How to try it: close a chapter named like v1.1.0, then open /changelog and read its sentence and pull links.

I did not run any tests for this push, since it only adds a commit message. The earlier module-state fix passed locally; the full suite runs on the forge.

commented

<!-- look-pages 7becf011ebd2 --> Look pages for 7becf01, from the gate:

  • look pages (none): "Looks: /changelog" is not a page of app.looks in forge.json; this pull changes src/web/pages/changelog.ts but the forge could not trace the route of /settings/security/controls (an inline or wrapped handler), so it could not infer a page; the reviewer decides. A "Looks: <path>" line naming the nearest page, or a "No look: <why>" line (10+ characters), says it
commented

Looks: /releases

I pushed an empty commit with that line. /changelog isn't in app.looks in forge.json, which is why the gate refused my last line. /releases is the nearest listed page, so I named that.

I didn't add /changelog to app.looks, because that changes which pages the forge screenshots for every pull, and I'd leave that to you. If you'd rather have it there, say so and I'll add it.

I ran no tests for this push; the code is unchanged from the last one.

The pull itself: a closed chapter's wave (for example one named v1.1.0) is one entry on /changelog, in its JSON and on the terminal's Changelog screen. Each entry has a sentence naming the chapter and up to ten pull links. The existing Changelog screen and docs/features/changelog.md are extended, with no new screen, and a No door: commit line says so. To try it: close a chapter named like v1.1.0, then open /changelog and read its sentence and pull links.

commented

<!-- look-pages b9934321625d --> Look pages for b993432, from the gate:

  • look pages (named): this pull changes src/web/pages/changelog.ts; a commit names /releases
commented

The gate's note on b993432 reports look pages (named): it accepted /releases as the page for src/web/pages/changelog.ts. It asks for no change, so I changed nothing and pushed nothing.

/releases is only the nearest page in app.looks. The page this pull actually changes is /changelog, which isn't in that list, so a reviewer should open /changelog itself.

A closed chapter's wave (for example one named v1.1.0) is one entry on /changelog, in its JSON and on the terminal's Changelog screen. Each entry has a sentence naming the chapter and up to ten pull links. Nothing in the code changed in the last three pushes.

To try it, close a chapter named like v1.1.0, then open /changelog and read its sentence and pull links.

Changes requested — before the latest push

Changes needed, first one first.

  1. (Both doors, box 2) On the terminal the wave's pull links are plain, unselectable text rows ({ row: { title } } with no pull:). A person cannot open any of them from the terminal, and the page can. Give each wave row its pull number so Enter opens it, or drop the duplication (see 3).
  2. (Speed) changelogPage now awaits withWaves before the ETag is computed, so every /changelog request does a ref read per closed chapter even when the answer is a 304. The 'answer a 304 without building the page' path is gone. Put a cheap stamp in the tag (the default branch tip per repo, which you already read) and read wave files only on a miss. Same cost lands in shippedAnswer for the JSON.
  3. (Design 1, 6, 7) The entry is hand-rolled markup: a <li class="small" data-wave> holding a <p> and a nested <ul> of links inside the chapter's row list. DESIGN.md wants rows from the named components, not a list inside a row. It also says the same pulls twice: the up-to-ten links sit directly above the chapter's own landing rows. Render the sentence as the chapter row's meta (the head row already takes meta) and make each link a row of the existing row component. If you need a new class, document it in docs/design/areas/<area>.md.
  4. (Preview) The preview's /changelog has no closed chapter, so I could not see the entry working; data-wave appears 0 times and /api/v1/changelog has waves: []. The unit test covers it, but add a closed chapter to the preview's sample data or show it in the pull.
  5. (Test) The JSON assertion reads waves[].links, but the terminal assertion only checks titles; once links are selectable (1), assert the pull number too.
commented

Four of the five changes are in and pushed. The fifth, showing a closed chapter in the preview, is not done. The rewrap the gate wanted went into the same commit.

Looks: /releases

  1. Terminal links open. Each wave line now carries its pull number, so Enter opens it. ChapterWave.pulls now carries the number, parsed from the link, and any link that isn't a pull's is dropped.
  2. The 304 path is back. The page tag now holds each repository's default-branch tip (waveTips: one ref read per repo, no wave file). withWaves runs only after a tag miss, and it reads each repo's tip once per call. The JSON answer (shippedAnswer) builds its tag from its own data, so it still reads one tip per repo plus the wave file on a tip change. The test asserts a repeat request returns 304.
  3. Rows, not hand-rolled markup. The wave's sentence is the chapter row's meta, replacing "Nothing landed yet." when there is a wave. A wave pull the chapter's landed rows don't already list gets one row of its own, so no pull is told twice. The wave link in my last version would almost always have repeated a landed row, which is why most chapters add no extra rows. The head row carries data-wave. No new component class, and bun scripts/design-lint.ts is clean.
  4. Preview: not done. I did not seed the preview's sample data, since that is a global change to what the sample shows. A closed chapter named like v1.1.0 with a wave file is what to look for on /changelog; the unit test builds exactly that.
  5. Tests. The terminal assertion now checks pull numbers 7001 to 7010. A new test covers a wave pull no landing lists (it gets a row) next to one that is listed (it doesn't repeat).

bun x tsc --noEmit is clean. test/changelog-chapters.test.ts, test/changelog.test.ts and test/module-state.test.ts pass (45 tests). I did not run the full suite; the forge's check does that on this push.

commented

<!-- look-pages b8fa13831888 --> Look pages for b8fa138, from the gate:

  • look pages (named): this pull changes src/web/pages/changelog.ts; a commit names /releases
commented

Nothing in this feedback needs a code change, so I pushed nothing.

The gate's line reads look pages (named). It is the gate noting that this pull changes src/web/pages/changelog.ts and that the commit b99343216 names /releases with a Looks: line. The gate passes with no refusal, and bun scripts/gate.ts still prints the same line.

I did not add /changelog to app.looks. forge.json already lists 32 pages, which is the limit in docs/APPS.md, so adding it would mean dropping another page's picture. /releases is the nearest listed page, which is why the commit names it. If a reviewer wants a picture of /changelog itself, one existing entry has to be swapped out, and that's their call.

Approved

Earlier asks: terminal wave lines carry pull numbers (met); the 304 path is back via waveTips, one ref read per repo (met); the sentence is the chapter row meta and unlisted pulls are plain rows, no new component, no hand-rolled markup (met); tests cover page, JSON, terminal lines, the 304 and the no-repeat rule (met). The preview has no closed chapter with a wave, so I could not see the entry live; the test builds it. Next two: (1) Non-blocking: seed a closed v-named chapter in the preview data so the entry can be seen. (2) Non-blocking: put /changelog into app.looks in place of a lesser page so its picture is taken.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs