docs: explain pipeline values, link style guide

Document what each value in the os workflow is for, link STYLE.md from
the README, and match its header example to mkosi.version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Job79andClaude Opus 5.5 committed 2026-11-16 20:09:00 +01:00
1 parent b7bbbf215b
commit 5d451beaef
3 files changed
+24 -3

No files matched your search

+22
View File
@@ -3,6 +3,28 @@
# Builds the OS image and publishes it as version "latest". VMs fetch the build # Builds the OS image and publishes it as version "latest". VMs fetch the build
# images as updates (mkosi.extra/usr/lib/sysupdate.d). Runs on every push, # images as updates (mkosi.extra/usr/lib/sysupdate.d). Runs on every push,
# weekly for package updates, and by hand for critical CVE's. # weekly for package updates, and by hand for critical CVE's.
#
# Values used below:
# - PKG upload location, <server>/api/packages/<owner>/generic/
# agent/latest. Path= in mkosi.extra/usr/lib/sysupdate.d/
# *.transfer points at the same place.
# - AUTH the job's automatic token (gitea.token), which can write
# the owner's packages.
# - SECUREBOOT_KEY repository secret: the private key of mkosi.crt, written
# to mkosi.key.
# - SIGNING_KEY repository secret: the armored private gpg key whose
# public half is mkosi.extra/usr/lib/systemd/
# import-pubring.pgp, which systemd-sysupdate checks.
# - zstd -19 -T0 the root and verity partitions have a fixed size (1 GiB,
# 64 MiB) and are mostly zero padding: zstd shrinks them
# from ~1.1 GB to ~245 MB. -19 is ~11% smaller than the
# default -3, for ~35 s more build time. -T0 uses all
# cores; --rm deletes the .raw files. systemd-sysupdate
# decompresses .raw.zst as it downloads.
# - qemu-img -c agent.qcow2, the whole disk compressed, for creating new
# VMs (not for updates).
# - SHA256SUMS checksums of the update files, signed as SHA256SUMS.gpg
# (Verify=yes in sysupdate.d).
name: os name: os
on: on:
push: push:
+1 -1
View File
@@ -23,7 +23,7 @@ As soon as Claude is logged in, `claude-remote.service` starts `claude remote-co
## Development ## Development
`mkosi.conf` defines the OS (`mkosi.extra/` is copied to `/`, `mkosi.repart/` is the disk layout, `mkosi.sandbox/` adds the Claude Code package repository). `mkosi.conf` defines the OS (`mkosi.extra/` is copied to `/`, `mkosi.repart/` is the disk layout, `mkosi.sandbox/` adds the Claude Code package repository). When changing files, follow [STYLE.md](STYLE.md).
```sh ```sh
mkosi build mkosi build
+1 -2
View File
@@ -16,8 +16,7 @@ Every file that allows comments starts with a header. It goes after the shebang,
#!/bin/sh #!/bin/sh
# Image version # Image version
# #
# Prints the build time in UTC (YYYYMMDDhhmm). Every build gets a higher version than the one # The build time (UTC), so every build is newer than the last.
# before, which is how systemd-sysupdate tells that an update is newer.
``` ```
- Line 1 is a title: a few words, in sentence case, with no full stop. - Line 1 is a title: a few words, in sentence case, with no full stop.