docs: review and correct comments and documentation (#436)

This commit is contained in:
ryan4yin | 二花 authored and GitHub committed 2026-10-12 10:02:38 +08:00
1 parent f32d67a5cc
commit 9c38819517
50 files changed
+148 -148

No files matched your search

+7 -3
View File
@@ -44,7 +44,8 @@ suite passes when every `expr` equals its `expected`.
#### Which tests cover a new host
Some tests iterate over every configuration, so a new host is covered automatically and must satisfy
them. Others name specific hosts and only cover a new host if you add it.
them. Others name specific hosts — or a name prefix, like `k3s-api-endpoint`, which covers every
`k3s-test-1-*` configuration — and only cover a new host if you add it.
| Kind | Tests |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -71,8 +72,11 @@ Problems:
agenix secrets.
- [ ] Maybe it's better to test every service separately, not the whole host?
No host defines a NixOS integration test yet: full-host tests are tracked as WA-013 in
[WORKAROUNDS.md](../WORKAROUNDS.md). What runs today is the eval set above, with `just test`.
Full-host tests are tracked as WA-013 in [WORKAROUNDS.md](../WORKAROUNDS.md).
`outputs/x86_64-linux/nixos-tests/idols-ruby.nix` is exported as
`packages.x86_64-linux.ruby-nixos-tests`, but it is not a `checks` entry, so CI never builds it and
nothing else runs it. What runs today is the eval set above with `just test`, plus one NixOS-driver
check of the shared firewall — `checks.x86_64-linux.security-exporters`, built in CI.
## Overview
+2 -1
View File
@@ -142,7 +142,8 @@ in
# Packages
packages = forAllSystems (system: allSystems.${system}.packages or { });
# Eval Tests for all NixOS & darwin systems.
# Eval Tests for all NixOS & darwin systems. Each system's `evalTests` lists its
# failures, so an empty attrset means that system passed.
evalTests = lib.lists.all (it: it.evalTests == { }) allSystemValues;
checks = forAllSystems (