luna/catacomb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs/roadmap: correct CI claims — Codeberg runs Woodpecker, not Forgejo Actions

Browse source 
The .forgejo/workflows/* definitions don't execute on Codeberg (no
runner). Docs publish via scripts/publish-docs.sh; tests/packages run
locally. Fixes claims introduced earlier today.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Luna 2026-06-07 03:27:04 -07:00
parent 9da16ca65f
commit 6f174f703b
3 changed files with 21 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

21
ROADMAP.md
View file

@ -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

6
docs/src/architecture.md
View file

@ -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

8
docs/src/packaging.md
View file

@ -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.