99# to noxfile.py and are invoked here only via `nox -s <session>`.
1010#
1111# Quick reference:
12- # just sync — install / update all dependency groups
13- # just check — self-lint: run Zenzic on its own documentation
14- # just build — MkDocs documentation build (fast, strict )
15- # just serve — start MkDocs documentation server (live-reload )
16- # just live — alias for serve
17- # just test — run test suite (delegates to nox)
18- # just preflight — full CI-equivalent pipeline (delegates to nox)
19- # just build-release — production build with BUILD_DATE
20- # just deploy — preflight + production build (local release check )
21- # just clean — remove generated artefacts
22-
23- runner := " uv run --active"
12+ # just sync — install / update all dependency groups
13+ # just check — self-lint: run Zenzic on its own documentation
14+ # just build — MkDocs documentation build (fast)
15+ # just build-prod — MkDocs documentation build (strict — mirrors CI )
16+ # just serve — start MkDocs documentation server (default: port 8000)
17+ # just live — alias for serve
18+ # just test — run test suite (delegates to nox)
19+ # just preflight — full CI-equivalent pipeline (delegates to nox)
20+ # just verify — preflight + build-prod (pre-push gate )
21+ # just clean — remove generated artefacts
22+
23+ runner := " uv run --active"
2424nox_runner := " uv run nox -s"
2525export BUILD_DATE := ` date +' %Y/%m/%d' `
2626
27+ # ─── Workflow ─────────────────────────────────────────────────────────────────
28+
2729# Install or update all dependency groups
2830sync :
2931 uv sync --all-groups
@@ -32,31 +34,35 @@ sync:
3234check :
3335 {{ runner }}
3436
35- # Build the documentation via MkDocs (fast — no PDF, no social cards)
36- build * args :
37- {{ runner }} {{ args }}
38-
39- # Serve the documentation using MkDocs (live-reload)
40- serve * args :
41- {{ runner }} {{ args }}
42-
43- # Alias: start the MkDocs development server with hot-reload
44- live : serve
45-
4637# Run the test suite (delegates to nox for reproducible isolation)
4738test * args :
4839 {{ nox_runner }} {{ args }}
4940
50- # Run the full CI-equivalent pipeline (delegates to nox )
41+ # Run the full quality pipeline (lint, typecheck, tests, reuse, security )
5142preflight :
5243 {{ nox_runner }}
5344
54- # Production build: injects the current date
55- build-release :
45+ # Full local verification: quality pipeline + production build (pre-push gate)
46+ verify : preflight build-prod
47+
48+ # ─── Documentation (MkDocs) ───────────────────────────────────────────────────
49+
50+ # Build the documentation (fast — no strict enforcement)
51+ build :
52+ {{ runner }}
53+
54+ # Build the documentation for production (strict — every warning is an error)
55+ build-prod :
5656 {{ runner }}
5757
58- # Local release check: full preflight followed by the production build
59- deploy : preflight build-release
58+ # Start the development server (override port: just serve 8001)
59+ serve port = " 8000":
60+ {{ runner }} {{ port }}
61+
62+ # Alias: start the development server
63+ live : serve
64+
65+ # ─── Cleanup ──────────────────────────────────────────────────────────────────
6066
6167# Remove generated artefacts (.nox is kept — reuse avoids reinstalling deps)
6268clean :
0 commit comments