mirror of
https://github.com/theupriser/steamify-cachyos-live-iso.git
synced 2026-10-02 15:10:26 +02:00
Merge pull request #24 from theupriser/docs/iso-todo-2
docs: TODO: tick off what is done, say what is left
This commit is contained in:
2 files changed
+12
-51
No files matched your search
@@ -26,46 +26,6 @@
|
||||
* Correctly handle VM environments
|
||||
* Correctly quote pacman arguments
|
||||
|
||||
## CachyOS with Steamify Live ISO
|
||||
CachyOS 26.08 with Steamify built in: install CachyOS and turn the PC into a Steam Machine in one go.
|
||||
Its version is the Steamify version on it plus the build date and time (UTC, when the release starts on GitHub; a release on `master` is `v<Steamify version>-<date>-<HHMM>`, e.g. `v2.9.3-2026.09.29-2015`). A new Steamify release starts one (a test build for now); by hand: Run workflow on "ISO 1/2 · Tag and release (GitHub)".
|
||||
Releases: GitHub creates the tag and a release with the notes; the ISO itself (over GitHub's 2 GB limit) is built on the Gitea mirror and attached to its release for that tag (git.upriser.nl).
|
||||
|
||||
**Features:**
|
||||
|
||||
* **ISO:** named after its release tag (`steamify-cachyos-2.9.3-2026.09.29-2030-x86_64.iso`; built by hand, without a tag: `local`), labelled after the Steamify version on it and the build time (`STEAMIFY_2_9_1_20260929_1432`, was CachyOS's `COS_<year><month>`); CachyOS Hello installs it like CachyOS's own
|
||||
release (the ISO's own release, its tag without the v, is in `/etc/steammachine-iso-build` and the boot menu)
|
||||
* **Installer (CachyOS - Steamify Installer):**
|
||||
* A Steamify page after the packages page: which Steam Machine parts to set up (rows from
|
||||
`steamify.sh --defaults --list`, the newest Steamify fetched before Calamares starts) and where
|
||||
the PC starts (gaming mode or the desktop)
|
||||
* The Summary lists every chosen item and where the PC starts
|
||||
* The new user's Steam Machine setup runs during the install (`steamify-install`, a Calamares step
|
||||
before cleanup): the first boot is already a Steam Machine
|
||||
* Only what Steamify supports is offered: KDE Plasma, and the boot loaders Limine, systemd-boot and
|
||||
GRUB (not rEFInd)
|
||||
* **Live session:** keeps CachyOS's own name; the power-off fix is built for the ISO's kernels, and
|
||||
the login has the Vapor look
|
||||
|
||||
**Fixes:**
|
||||
|
||||
* **systemd-boot:** the installed system gets its "Linux Boot Manager" EFI boot entry, first in the
|
||||
boot order. cachyos-installer runs `bootctl install` in a chroot, where bootctl leaves the EFI
|
||||
variables alone, so the entry was missing: the PC could only boot through the disk's fallback path
|
||||
(`\EFI\BOOT\BOOTX64.EFI`). Most PCs find it early and boot normally, but firmware that tries the
|
||||
network first waits minutes on every boot (QEMU/OVMF: PXE, HTTP boot and the EFI shell come first),
|
||||
and anything else that writes the fallback file (another OS) takes the boot over.
|
||||
`steamify-install` now registers it with `efibootmgr` from the live system, with the ESP's real
|
||||
disk and partition (bootctl in the chroot writes an entry without a partition, which the firmware
|
||||
can't load); the output is in `/var/log/steamify-bootentry.log`
|
||||
* **Installer:** Steamify's install-time logs (`/var/log/steamify-install.log`,
|
||||
`steamify-bootentry.log`) are readable after the first boot: `/var/log` is its own btrfs subvolume
|
||||
(`@log`) that wasn't mounted yet when Steamify ran, so they ended up hidden under it
|
||||
* **Installer:** Steamify's setup never asks for a password (its sudo rule is read after CachyOS's
|
||||
`%wheel` rule); Calamares starts with the Boost version it was linked against
|
||||
* **Build:** finishes cleanly as root and reports no error after a successful build; the Steamify page's
|
||||
Calamares module is built with the ISO and left out when Calamares' version differs
|
||||
|
||||
# 26.07
|
||||
**Features:**
|
||||
|
||||
|
||||
@@ -11,18 +11,14 @@ Tick items off as they are done; the newest entries are at the top of each list.
|
||||
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
|
||||
- [ ] **Names, the live session**: the installed system's names were checked (2026-09-30: `os-release` and `lsb-release` are
|
||||
CachyOS's, test B3). Still to look at: the installer title, Hello and About this System in the live session (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.
|
||||
- [ ] **Retention, first clean-up**: the code is merged (PR #22: at most 10 dev + 10 real releases, the mirror's release with
|
||||
its ISO is deleted first). Watch the first time there are more than 10 releases of a kind; it hasn't run yet.
|
||||
- [ ] **Build badge, the other states**: succeeded was seen (`v2.9.6-260930`). Failed, cancelled and a build superseded by a
|
||||
newer one haven't been seen; a crashed runner leaves the badge on "running".
|
||||
- [ ] **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.
|
||||
|
||||
@@ -42,7 +38,12 @@ Tick items off as they are done; the newest entries are at the top of each list.
|
||||
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] **Retention** of at most 10 dev and 10 real releases, deleting the mirror's release with its ISO too (PR #22; first
|
||||
clean-up still to be seen, above).
|
||||
- [x] **Old hand-written `CHANGELOG.md` section** (`## CachyOS with Steamify Live ISO`) removed: the release notes are generated.
|
||||
- [x] **Same-day replacement of a real release** (2026-09-30): the official build for `v2.9.6-260930` replaced the test build's
|
||||
release on the mirror (ISO asset 42 -> 50, new title and generated notes, badge green with the public run link).
|
||||
- [x] **Release notes** leave out the workflow and docs commits (`ci`, `docs`, `…(ci):`) in their list of ISO changes.
|
||||
- [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.
|
||||
|
||||
Reference in new issue
Block a user