0 Fork 0

mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2026-11-09 12:17:13 +00:00

Files

T

kevinveenbirkenbachandClaude Opus 5 fcc98bcad1 fix(docs): require a README behind every directory link

The lint accepted a link that resolved to a file or a directory. myst
builds a document reference only when the target is_file(), so a link to
a directory without a README is a bare file listing on GitHub and a dead
cross-reference in the documentation build. It now reports which of the
two reasons applies.

The tightened rule found 41 links. Where a README backs the directory,
bd15eae9fa's resolver carries the link and it stays. Where none exists,
the link becomes a code span rather than an invented README: 15 of them
point at a role's meta/addons/, whose addon table already sits below the
sentence, and the rest at code directories such as utils/ or
cli/administration/deploy/runner/.

The changed sentences are msgids, so these entries return to the
translator on the next extract.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

2026-09-25 18:42:23 +02:00

3.2 KiB

Raw Blame History

Environment Variables

The project's environment is owned by a single generator, not scattered across shell modules. Every variable is documented INLINE next to its definition with a one-line # ... comment above the key. This page is just a map of where to look.

Where the defaults live

default.env holds the committed defaults for every static key (network defaults like DNS, subnet, gateway, domain included), each preceded by a one-line comment. Edit this file to change a default or to read the per-variable documentation.
.env (gitignored) is generated by make dotenv, which delegates to python -m cli.meta.env. It combines default.env with runtime-resolved values (selected distro, GHA/Act flags, df/meminfo-derived cache sizes, sha256 secrets, repository owner, ...). Each line in .env is preceded by its own comment, so the file is self-describing. Open it after make dotenv to inspect the effective value-set together with its documentation.

Regenerating

make dotenv

Override individual values by exporting them before make dotenv. Already-set env vars take precedence over default.env defaults.

Pipeline

env/ (under utils/) holds the parser, runtime helpers, writer, and one handler module per dynamically-computed variable under handlers/.
cli/meta/env/ provides the CLI entry point invoked as python -m cli.meta.env.
load.sh is the shell loader; it sources .env and auto-generates it on a cold clone.

Variables NOT in `default.env`

A handful of variables are documented next to their consumer because they cannot have a static default:

Driver-injected by make compose-up and the dev CLI (cache override paths like INFINITO_CACHE_REGISTRY_PROXY_CONF, the package-cache config paths, the frontend CA file). See common.py and compose.yml.md.
Computed at container start for INFINITO_PATH, set by entry.sh.
Persisted on the deploy target for INFINITO_VERSION, written by the sys-version role.
Compose literals with no env-side knob, namely GIT_SSL_NO_VERIFY and PYTHONHTTPSVERIFY, documented in compose.yml.md.
Fork identity for the operator's CI-redeploy shortcuts: INFINITO_FORK_ACCOUNT (defaults to the local OS username) and INFINITO_FORK_REPOSITORY_URL (composed as https://github.com/$INFINITO_FORK_ACCOUNT/$INFINITO_FORK_REPOSITORY_NAME), both set by handlers under utils/env/handlers/infinito/ (fork_account.py, fork_repository_url.py). The fork repository name itself lives in default.env as INFINITO_FORK_REPOSITORY_NAME.

Role-scoped variables

App-specific container variables live next to the role that owns them, typically in roles/<role>/templates/env.j2, roles/<role>/templates/bootstrap.env.j2, or roles/<role>/templates/playwright.env.j2. They are intentionally NOT centralised here so the app documentation and its generated env file stay in sync.

3.2 KiB Raw Blame History