Merge pull request #23 from theupriser/docs/iso-todo

docs: TODO as a checkbox list, up to date

.github/workflows/iso-1-github-tag.yml

@@ -118,13 +118,20 @@ jobs:
           echo "ISO_TAG=$tag" >> "$GITHUB_ENV"
           echo "STEAMIFY_REF=$sref" >> "$GITHUB_ENV"
 
-          # Retention (space): at most 10 dev and 10 real releases; the oldest go, release and tag. The mirror drops the
-          # tag with its release and ISO at its next sync (the step below).
+          # Retention (space): at most 10 dev and 10 real releases; the oldest go: the mirror's release with its ISO, then the GitHub
+          # release and tag (the mirror drops the tag at its next sync, the step below).
           keep=10
           for pre_flag in true false; do
             gh release list -L 200 --json tagName,isPrerelease,createdAt \
                 -q "[.[] | select(.isPrerelease == $pre_flag)] | sort_by(.createdAt) | reverse | .[$keep:][] | .tagName" |
-              while read -r old; do echo "Retention: removing $old"; gh release delete "$old" --cleanup-tag -y; done
+              while read -r old; do
+                echo "Retention: removing $old"
+                # The mirror keeps a release (and its 3 GB ISO) after its tag is gone, so it is deleted there first.
+                if [ -n "$GIT_UPRISER_TOKEN" ]; then
+                  curl -sS -X DELETE -H "Authorization: token $GIT_UPRISER_TOKEN" -o /dev/null -w "  mirror release $old: HTTP %{http_code}\n" "$GITEA_URL/api/v1/repos/$GITEA_REPO/releases/tags/$old" || true
+                fi
+                gh release delete "$old" --cleanup-tag -y
+              done
           done
 
       # The mirror takes the tag (sync), then the build on the mirror is started explicitly (its dispatch API): a tag that

AGENTS.md

@@ -119,7 +119,7 @@ Full write-up, with every trap: `steamify-iso-release` in steamify-cachyos-dev.
   date, no time): `vX.Y.Z-YYMMDD` (real) or `vX.Y.Z-dev-YYMMDD` (dev), file `steamify-cachyos-X.Y.Z-[dev-]YYMMDD-x86_64.iso`, an **annotated** tag and a
   release with notes and the direct download link. One ISO per day and kind: a second build the same day deletes
   the earlier release and tag (GitHub) and tags again; the mirror takes the new tag object, iso-2 replaces the old mirror release. Retention: at most 10 dev and 10 real
-  releases are kept (space); the oldest are deleted with `gh release delete --cleanup-tag`, and the mirror drops their tags, releases and ISOs at its next sync. The workflow always runs from `master`; its input `steamify_ref` (a Steamify branch or tag, empty = the newest published release) builds the ISO with that checkout and names it after that branch's `VERSION` (a release branch tests its own version before it is released); its input `kind` (`release`, `dev`, or `auto`: release on master, dev on other branches) decides: `release` is a real release, `dev` a `dev-` pre-release. steamify-cachyos' bundle.yml passes it: a version published from main -> `release`, a version on a release branch -> `dev`.
+  releases are kept (space); the oldest are deleted: first the mirror's release with its ISO (Gitea API, `GIT_UPRISER_TOKEN`), then the GitHub release and tag with `gh release delete --cleanup-tag`; the mirror drops the tag at its next sync. (A mirror release is NOT removed by a tag deletion alone: it stays, tagless, with its ISO.) The workflow always runs from `master`; its input `steamify_ref` (a Steamify branch or tag, empty = the newest published release) builds the ISO with that checkout and names it after that branch's `VERSION` (a release branch tests its own version before it is released); its input `kind` (`release`, `dev`, or `auto`: release on master, dev on other branches) decides: `release` is a real release, `dev` a `dev-` pre-release. steamify-cachyos' bundle.yml passes it: a version published from main -> `release`, a version on a release branch -> `dev`.
 - `.github/workflows/iso-2-gitea-build.yml` (Gitea, `workflow_dispatch` with the tag as the ref, started by iso-1's last step through the mirror's dispatch API after the mirror has the new tag object; a tag push starts nothing, because a replaced tag of the same name starts no run; skipped on GitHub) runs two jobs for that
   tag: build the ISO, then attach it to the mirror's release. It is not tested there (the runner is small): the VM tests
   run on GitHub, in steamify-cachyos `vmtest.yml`, on the newest ISO release of the mirror. The tag decides everything: Steamify version (`steamify-prepare.sh`

TODO.md

@@ -1,89 +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 stays `steamify-cachyos-<date>.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. Only pass
-   `steamify-prepare.sh <checkout>` / `vmisobuild.sh --steamify <path>` when
-   testing an *unreleased* Steamify change.
-5. **Build in the test VM** instead of on the Steam Machine
-   (steam-machine-iso skill), and install the result unattended with
-   `scripts/vminstall.sh --iso` (vm-install skill; the Calamares Steamify
-   step then needs `steamify-install` run from the live script).
-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-<date>-x86_64.iso` (`iso_name` in
-  `archiso/profiledef.sh`); the volume label stays `COS_<yyyymm>`.
-- **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<steamify>-<YYMMDD>` (dev: `v<steamify>-dev-<YYMMDD>`), file
+      `steamify-cachyos-<steamify>-[dev-]<YYMMDD>-x86_64.iso`, label `STEAMIFY_<version>_<YYMMDD>`; 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/<tag>`).
+- [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 <base> with Steamify <version> (<date> 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-<date>-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`.