Files
jellytau/docs/specs/README.md
T
dtourolle 5d02628689
🏗️ Build and Test JellyTau / Run Tests (pull_request) Successful in 15m1s
🏗️ Build and Test JellyTau / Supply Chain (pull_request) Successful in 42s
Traceability Validation / Check Requirement Traces (pull_request) Successful in 10s
🏗️ Build and Test JellyTau / Android Compile Check (pull_request) Successful in 4m6s
fix(release): publish real notes, and stop shipping old releases' installers
Two defects found while preparing v0.9.2, both of which had been shipping
for months without anything to notice them by.

**Every release note was the same 1,050 bytes.** All 35 releases from
v0.0.1 to v0.9.1 published identical generic install instructions whose
"What's New" section read "See CHANGELOG.md" -- a link that does not
resolve from a release page. A reader learned nothing about what changed
in any release the project has ever made.

The body now comes from the `## <version>` section of CHANGELOG.md, and a
missing section fails the release: notes that say nothing are worse than
a build that waits for a maintainer to write two sentences. The 35
published bodies have been backfilled from the changelog via the tea CLI.

This also corrects something introduced two commits ago. That change
generated the body from `bun run release:notes`, which CLAUDE.md is
explicit about -- its output is "a reviewed draft, not a final
changelog". Publishing it unreviewed proved the point immediately: the
v0.9.1..HEAD range contains a repo-wide prettier sweep, so every file in
src/ counted as changed, their TRACES resolved to nearly the whole
matrix, and the draft claimed the release had added the entire
application. The script now skips cosmetic commits (chore(format),
chore(deps), style) and reports how many rather than silently returning a
smaller set, but it stays a local drafting tool.

**Every release from v0.1.0 to v0.8.2 shipped every Windows installer
ever built.** src-tauri/target/*/release/bundle/ is not versioned, cargo
never cleans it, and the runner reuses the target directory -- so the
copy step's bundle/**/*-setup.exe glob collected the lot. v0.8.2 carried
sixteen installers, thirteen of them stale; v0.5.0 offered users a
download list going back to 0.1.0. Eight months, and nothing to notice it
by: the upload loop reported success, the files were real, and the page
looked busy rather than wrong. It stopped only because an unrelated cargo
cache change wiped the runner's target dir, so it was dormant, not fixed.

Both desktop builds now remove the bundle directory before building, so a
stale file cannot exist to be copied. Filtering the copy by version would
have hidden it instead. The Linux job gets the same treatment: it was
never hit only because Linux packaging is newer, and the glob is
identical.

scripts/check-release-artifacts.sh is the backstop for whatever
reintroduces one by a route nobody predicted. It runs before the SBOM,
the checksums and the upload -- all of which describe the file set, so a
stale artifact has to be caught before it is hashed and published as part
of the release. Verified against a reconstruction of the real v0.8.2
accumulation.

DR-219, DR-220, UT-210.
2026-08-21 19:54:46 +02:00

5.6 KiB

Specs index

Feature specs for JellyTau. Start a new one from SPEC-TEMPLATE.md and run it past SPEC-REVIEW-CHECKLIST.md before accepting it.

What lives here

Only work that has not shipped. Once a spec is fully implemented its design is folded into the architecture docs — which are the maintained description of the build — and the spec file is deleted. Git history keeps the original, including its rejected alternatives and acceptance criteria; the architecture docs keep the reasoning that a future change still needs.

So: a file in this directory is a promise, not a description. If you want to know how something works, read docs/architecture/. If you want to know what is planned, read here.

Status vocabulary

Status Meaning
Proposed Written, not accepted. Nothing built.
Accepted Agreed as the design; implementation not started or not finished.
Partially implemented Some parts shipped; the spec names what is left.
Design authority No code of its own — it records a decision later specs act on.

Next free requirement ids (always re-check requirements.md before allocating): UR-079, IR-033, DR-221. Three specs below suggested ids that have since been taken by other work; each carries a ⚠️ note at the top.

Partially implemented

Spec What landed What is left
frontend-domain-model.md Catalog surface: MediaKind, from_jellyfin isolated, ticks → ms primaryImageTagimageId (~30 sites); player/session/reporting tick math; stream.type
libmpv2-migration.md LICENSE The libmpvlibmpv2 crate swap
read-through-media-cache.md DR-126…128, DR-133…138 — cache entries are download rows; local playback of downloads DR-121/122/124/125 — the player quality selector and the read-through capture
scoped-search-boundary-implementation.md Stage 1: SearchScope owned by Rust (DR-063…067) Stage 2: result-side grouping (GROUP_ITEM_TYPES still in searchScope.ts)

Not started

Spec Blocked on / note
backend-owned-stream-selection.md Rust owns direct-play-vs-transcode, transport and quality; players consume one StreamSelection. Phase 1 (delete the .m3u8 sniff) stands alone. Unblocks Linux native video.
build-provenance.md build.rs is still bare. ⚠️ suggested id DR-093 is taken.
player-facade-enforcement.md ~60 commands.player* sites still outside the facade; no lint rule. ⚠️ suggested id DR-095 is taken.
windows-native-audio-backend.md Blocked on the libmpv2 swap. ⚠️ suggested id IR-030 is taken.
linux-native-video-spike.md Spike run 2026-08-21: compositing works on Linux, X11 and Wayland. G1-G6 green bar the Tauri default_vbox() half of G1. Needs an implementation spec that answers adaptive bitrate.

Design authority

Spec Role
playback-backend-unification.md Why video cannot unify onto one native engine and audio can. The audio half has since shipped on Android; Windows has not.
scoped-search-boundary.md The boundary design the check:boundary rule came from. Stage 1 built.
scoped-search.md Superseded in part — its "frontend only, no Rust changes" decision is the leak the boundary spec reversed. UX still current.

Where the shipped specs went

Sixteen specs were folded into the architecture docs and deleted (2026-08-21). Where to look for each:

Shipped work Now documented in
Account menu & global chrome 02-svelte-frontend.md — App Shell and Chrome
Library mosaic 02-svelte-frontend.md — Library Mosaic
Series current-episode navigation 02-svelte-frontend.md — Series and Episode Navigation
Downloads as an offline library 02-svelte-frontend.md — Downloaded Browse
Favourites browsing 01-rust-backend.md — Favorites System
Streaming bitrate cap 01-rust-backend.md — Streaming quality ladder
Locally-indexed search 03-data-flow.md — Search Flow; 01-rust-backend.md — Background workers
Offline downloaded-only filter 06-downloads-and-offline.md — Offline Catalog Visibility
Audio equalizer · Android audio settings parity 05-platform-backends.md — Audio settings on ExoPlayer
Android native video spike 05-platform-backends.md — Native Video Compositing
Video background audio 05-platform-backends.md — Background Audio Handoff
Traceability gate repair traceability-ci.md
Boundary tripwire hardening scripts/check-frontend-boundary.sh (its header is the spec)
Playback docs corrections · req-coverage script removal Nothing to document — both were corrections that have been applied