diff --git a/TODO.md b/TODO.md index 767da5e..7e0c878 100644 --- a/TODO.md +++ b/TODO.md @@ -1,87 +1,74 @@ # To do (Steam Machine edition) +Tick items off as they are done; the newest entries are at the top of each list. + ## Open -1. **Steamify installer page** (2026-09-28, working end to end; see - `AGENTS.md` for the module/build/testing details and gotchas behind - this). `packagechooserq` (custom QML) is built with each ISO by - `build-calamares-modules.sh` into `archiso/airootfs/usr/lib/calamares/modules/packagechooserq/`. - `netinstall` (checkbox tree) stays as a manually-swappable fallback - (`steamify-cachyos-dev/share/sn.sh` + `nisteamify.conf`) for when the - module can't load, but isn't wired into `calamares-online.sh` - automatically yet. - - **Still open**: - - A Python job (e.g. `steamifychoice`, before `packages@online`) to - normalize either page's choice (packagechooserq's - `packagechooser_steamifypage` GS key, or netinstall's - packageOperations markers) into one `steamifyChoice` GS key, so - `shellprocess_steamify.conf` doesn't need to know which page ran. - -2. **Names**: only the installer says Steamify ("CachyOS with Steamify - Installer", productName set by calamares-online.sh); the live session, - Hello and About this System keep CachyOS's own names (legal clarity). The - ISO file is named by the day, like CachyOS: `steamify-cachyos--[dev-]-x86_64.iso`. -3. **Check the names** after the next build: installer title, Hello and - About this System say CachyOS. -4. ~~Steamify PR for `feat/defaults-options`~~ — done: 2.7.0 (`--options`, - `--boot`, `steamify.sh --boot` standalone) and 2.8.0 - (`--defaults --list`, what the Steamify page's rows come from) are both - released. **The ISO builder is up to date with this**: no checkout - argument needed, `steamify-prepare.sh` (no args) and `calamares-online.sh` - at boot both just fetch the newest release, so the ISO always has 2.8.0+ - without a rebuild for a Steamify-side change alone. A build of an *unreleased* Steamify change passes it as the input - `steamify_ref` of `iso-1-github-tag.yml` (a release branch does this by itself); - by hand: `steamify-prepare.sh ` / `vmisobuild.sh --steamify `. -5. ~~Build in the test VM~~ — done: the ISO is built on the Gitea mirror's runner by `iso-2-gitea-build.yml` (see the - `steamify-iso-release` skill in steamify-cachyos-dev); test the result locally with `scripts/vmtest.sh --install`. -6. **Test on the real Steam Machine** from a USB stick (gamescope, LEDs, CEC, - power-off) before calling the ISO usable. +- [ ] **Steamify installer page, one choice key** (2026-09-28; the page works end to end, see `AGENTS.md` for the + module/build/testing details). `packagechooserq` (custom QML) is built with each ISO by + `build-calamares-modules.sh`. `netinstall` (checkbox tree) stays a manually swappable fallback + (`steamify-cachyos-dev/share/sn.sh` + `nisteamify.conf`), not wired into `calamares-online.sh`. + Still to do: a Python job (e.g. `steamifychoice`, before `packages@online`) that normalizes either page's choice + (`packagechooser_steamifypage` GS key, or netinstall's packageOperations markers) into one `steamifyChoice` + GS key, so `shellprocess_steamify.conf` doesn't need to know which page ran. +- [ ] **Check the names after the next build**: the installer title, Hello and About this System say CachyOS (only the + installer says Steamify). +- [ ] **Test on the real Steam Machine** from a USB stick (gamescope, LEDs, CEC, power-off) before calling the ISO usable. +- [ ] **Retention** (PR #22, at most 10 dev + 10 real releases, deleting the mirror's release with the ISO too): watch it + the first time there are more than 10 releases of a kind; until then it is untested. +- [ ] **Build badge**: the failed and cancelled states, and a build that is superseded by a newer one, haven't been seen + yet (only succeeded). A crashed runner leaves the badge on "running". +- [ ] **Same-day replacement on the mirror** of a real release (second `kind=release` build of one day): check that the + mirror's release gets the new ISO (new asset id) and notes. +- [ ] **CHANGELOG.md**: the hand-written section `## CachyOS with Steamify Live ISO` is no longer used (the release notes + are generated); delete it or turn it into something else. +- [ ] **Release notes**: the list of ISO changes is raw commit subjects (ci/docs left out); maybe filter or group them. +- [ ] **Check with the CachyOS team** whether the installer branding and the ISO file name are fine with them. +- [ ] **Drop the Boost 1.91 workaround** in `steamify-prepare.sh` once `cachyos-calamares-next` is rebuilt against the repos' Boost. ## Done -- **Full ISO install with the Steamify page** (2026-09-28, ISO VM, - `--fremont`, Start in: desktop): Summary listed the choices, the - install step ran Steamify 2.8.0 with every item OK, `--boot desktop` - applied, `exit: 0`; the installed system boots into the desktop. -- **Steamify Summary** (2026-09-28, ISO VM): an unordered list of the chosen - items' names plus "Starts in gaming mode/the desktop" - (`patches/packagechooserq-steamify-summary.patch`), with `items.json` - written by the launcher (its `$sdir` bug fixed, `0cc7367`). -- **packagechooserq built with the ISO** (2026-09-28): - `build-calamares-modules.sh` builds it in the build container/VM from - CachyOS's Calamares source against the current `cachyos-calamares-next` - (no prebuilt `.so` in git), with `built-for`; `calamares-online.sh` leaves - the Steamify page out when the Calamares it runs differs (the step then - installs everything on) instead of risking "Initialization Failed". -- **Steamify 2.6.0** released (`--defaults`, install-time mode). -- **Live session** (VM, `--fremont`): Vapor look and layout (Steam Deck - wallpaper) at the live login; the power-off module is built for both ISO - kernels and loaded at boot, in the VM it returns "No such device" (no - AMDI0030 GPIO controller), as designed. Whether it keeps the real Steam - Machine off is part of the hardware test. -- **Regression test 2.6.0 on an existing desktop install** (test VM from - ssh-ready, `--fremont`): full first run, re-apply, notifications/CEC/theme - off and on again. No errors; user units enabled and running, theme applied - and restored live, no first-login autostart with a session. -- **ISO name**: `steamify-cachyos--x86_64.iso` (`iso_name` in - `archiso/profiledef.sh`); the volume label stays `COS_`. -- **VM install from the ISO (2026-09-27, `f42859a`):** a VM install from the ISO (Hello's - Install, no manual fixes) ran Steamify's step: every component OK, - `exit: 0`, SDDM autologin into gamescope. First desktop login (session switched to plasma in the VM) passed too: - Vapor layout, the app opened with everything on. The first-login script - runs the newest *release*, so it only works once 2.6.0 is released (in the - test it was pointed at the bundle). - The VM's text - console doesn't show (virgl): read the installed disk with - `qemu-nbd -r` + `mount -o ro,rescue=nologreplay,subvol=@` (logs in `@log`). +### Release pipeline (2026-09-29 and 2026-09-30) -## Later +- [x] **Daily names like CachyOS**: tag `v-` (dev: `v-dev-`), file + `steamify-cachyos--[dev-]-x86_64.iso`, label `STEAMIFY__`; one ISO per day and + kind, the newest build replaces the earlier one. +- [x] **Always from `master`**: `iso-1-github-tag.yml` takes `kind` (release, dev, auto); steamify-cachyos' `bundle.yml` asks + for `release` (a version published from main) or `dev` (an unreleased version on a release branch). +- [x] **`steamify_ref`**: a release branch builds its dev ISO with its own Steamify (and VERSION) before it is released. +- [x] **The mirror's build is started by dispatch** after the mirror has the new tag object (a replaced tag starts no run by + itself; the dispatch needs the full ref `refs/tags/`). +- [x] **Build badge** in the GitHub release: running, then succeeded / failed / cancelled (secret `GH_RELEASE_TOKEN` on the + mirror), linked to the public Gitea run. +- [x] **Generated release notes** and title (`CachyOS with Steamify ( UTC)`): base version, Steamify's + changelog section, commits since the previous release; the mirror's release uses the same text. +- [x] **Retention** of at most 10 dev and 10 real releases (PR #22 also deletes the mirror's release with its ISO). +- [x] **The ISO is built on the Gitea mirror's runner** (`iso-2-gitea-build.yml`) and hosted there (over GitHub's 2 GB limit); + the VM tests run locally (`scripts/vmtest.sh --install` in steamify-cachyos-dev), not on the runners. +- [x] **Build in the test VM instead of on the Steam Machine**: superseded by the runner above. -- **Branding**: only the installer carries Steamify's name; check with the - CachyOS team whether that and the ISO file name are fine with them. -- **Release**: a CI job that builds the ISO (privileged container, flags from - the steam-machine-iso skill) and hosts it (>2 GB, not a GitHub release asset). -- **Drop the Boost 1.91 workaround** in `steamify-prepare.sh` once - `cachyos-calamares-next` is rebuilt against the repos' Boost. +### Installer, live session and Steamify (2026-09-27 to 2026-09-29) -Build and test details: the `steam-machine-iso` skill in steamify-cachyos-dev. +- [x] **Steamify PR `feat/defaults-options`**: 2.7.0 (`--options`, `--boot`) and 2.8.0 (`--defaults --list`) released; the ISO + fetches the newest release, nothing to pass for a Steamify-side change alone. +- [x] **Full ISO install with the Steamify page** (2026-09-28, ISO VM, `--fremont`, Start in: desktop): the Summary listed + the choices, the install step ran Steamify 2.8.0 with every item OK, `--boot desktop` applied, `exit: 0`; the + installed system boots into the desktop. +- [x] **Steamify Summary** (2026-09-28): an unordered list of the chosen items' names plus "Starts in gaming mode/the + desktop" (`patches/packagechooserq-steamify-summary.patch`), with `items.json` written by the launcher. +- [x] **packagechooserq built with the ISO** (2026-09-28): `build-calamares-modules.sh` builds it against the current + `cachyos-calamares-next` (no prebuilt `.so` in git), with `built-for`; `calamares-online.sh` leaves the Steamify + page out when the Calamares it runs differs (the step then installs everything on). +- [x] **Steamify 2.6.0** released (`--defaults`, install-time mode). +- [x] **Live session** (VM, `--fremont`): Vapor look and layout (Steam Deck wallpaper) at the live login; the power-off + module is built for both ISO kernels and loaded at boot (in the VM it returns "No such device": no AMDI0030 GPIO + controller, as designed; whether it keeps the real Steam Machine off is part of the hardware test). +- [x] **Regression test 2.6.0 on an existing desktop install** (test VM from ssh-ready, `--fremont`): full first run, + re-apply, notifications/CEC/theme off and on again; no errors. +- [x] **ISO name** (first version, since superseded by the daily names above): `steamify-cachyos--x86_64.iso`. +- [x] **VM install from the ISO** (2026-09-27, `f42859a`): ran Steamify's step with every component OK, `exit: 0`, SDDM + autologin into gamescope; the first desktop login passed too (Vapor layout, the app opened with everything on). The + VM's text console doesn't show (virgl): read the installed disk with `qemu-nbd -r` + `mount -o ro,rescue=nologreplay,subvol=@` + (logs in `@log`). + +Build and test details: the `steam-machine-iso` skill in steamify-cachyos-dev; the release pipeline: `steamify-iso-release`.