diff --git a/ROADMAP.md b/ROADMAP.md index 66b9ac3..07a460e 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -80,20 +80,23 @@ end-to-end tests that spawn the **real** `--web` binary against a scratch tempdir and drive the HTTP API with curl (index/library serving, ETag 304, settings round-trip + persistence, folders CRUD + cycle guard, notes round-trip, channel-options round-trip + clear, DB backup). Each test -gets its own server/port/tempdir, so they run in parallel. -`.forgejo/workflows/test.yml` runs the full suite on every push. Stretch -left: a recorded-fixture corpus for the download pipeline and a headless -web-UI test. +gets its own server/port/tempdir, so they run in parallel — `cargo test` +runs the lot. (A `.forgejo/workflows/test.yml` CI definition exists, but +Codeberg executes Woodpecker, not Forgejo Actions, so it's inert there +without a self-hosted runner; tests run locally.) Stretch left: a +recorded-fixture corpus for the download pipeline and a headless web-UI +test. ### 2.2 Documentation site — DONE An mdBook under `docs/` (eight pages: introduction, installation, first-run/config, downloading, anti-bot, troubleshooting, architecture, -packaging), published to Codeberg Pages by -`.forgejo/workflows/docs.yml`. The anti-bot and troubleshooting pages -capture the cookies/curl_cffi/POT/player-client knowledge; the -architecture page documents the two-front-ends/one-engine design for -contributors. +packaging), published to Codeberg Pages via `scripts/publish-docs.sh` +(build the book + force-push it to the `pages` branch — Codeberg doesn't +run Forgejo Actions, so publishing is a local one-liner rather than CI). +The anti-bot and troubleshooting pages capture the cookies/curl_cffi/POT/ +player-client knowledge; the architecture page documents the +two-front-ends/one-engine design for contributors. ### 2.3 Error recovery / structured logging — DONE diff --git a/docs/src/architecture.md b/docs/src/architecture.md index dc39578..3012214 100644 --- a/docs/src/architecture.md +++ b/docs/src/architecture.md @@ -95,8 +95,10 @@ wall is RateLimited, not NotFound). and drives the HTTP API with curl — genuine end-to-end coverage of the axum + SQLite + config stack. -`cargo test` runs both. `.forgejo/workflows/test.yml` runs them on every -push. +`cargo test` runs both. (A `.forgejo/workflows/test.yml` CI definition +exists, but Codeberg runs Woodpecker rather than Forgejo Actions, so it +doesn't execute there without a self-hosted runner — run the suite +locally.) ## Platform support diff --git a/docs/src/packaging.md b/docs/src/packaging.md index 6fd42eb..8db4bdb 100644 --- a/docs/src/packaging.md +++ b/docs/src/packaging.md @@ -31,9 +31,11 @@ lands in `dist/`. ## CI -`.forgejo/workflows/release.yml` runs `scripts/package.sh all` on every -pushed `v*` tag and attaches the artifacts to the Codeberg release. -`.forgejo/workflows/test.yml` runs the full test suite on every push. +The repo ships `.forgejo/workflows/` definitions (`test.yml`, +`release.yml`), but Codeberg executes Woodpecker rather than Forgejo +Actions — so they don't run there without a self-hosted runner. Until +then, build packages locally with `scripts/package.sh` and publish docs +with `scripts/publish-docs.sh`. The repo's [`docs/PACKAGING.md`](https://codeberg.org/anassaeneroi/yt-offline/src/branch/main/docs/PACKAGING.md) has the per-distro install commands and the Windows/macOS status in full.