Repository navigation
Dev Ci
.github/workflows/ci.yml checks every pull request and every push to main. A pull request runs only the jobs its changes need; pushes to main and manual runs (gh workflow run ci.yml) are not scoped and run what they always ran (the fast jobs on a push, everything by hand).
The first job, changes, lists the files the pull request changes (the diff between the merge commit and the base branch) and maps each path to the jobs that check it with tools/repo-checks/scripts/ci_scope.py. It writes one output per job (true or false) and a table "CI scope" with the reason for every job into the run's summary. Every other job waits for changes and runs unless its output is false.
| Changed path | Jobs that run (besides ci-config) |
|---|---|
.github/** (workflows, Dependabot, templates), .releaserc.json, socket.yml, osv-scanner.toml, .pre-commit-config.yaml, .clusterfuzzlite/**, repo-checks tests and CI-only scripts |
none; for ci.yml the jobs whose definition changed (below) |
docs/**, mkdocs.yml, README.md, CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md
|
docs |
infra/helm/** |
helm |
tests/load/** |
compose |
apps/mobile/** |
web (+ gradle-wrapper for the Gradle wrapper) |
apps/web/**, libs/mowdeck-ui/**, tools/ts-codegen/**, services/matter-server/**, package.json, pnpm-lock.yaml, .node-version, ESLint/Stylelint/Prettier configuration |
web, docker, camera-relay-media, e2e, e2e-web, e2e-demo (apps/web/openapi/** also python and docs) |
services/**, libs/**
|
python, docs, docker, camera-relay-media, e2e, e2e-web, e2e-demo (libs/** also openfga-model) |
pyproject.toml, uv.lock, .python-version, infra/compose/**, infra/mirror-env.sh, infra/openfga/**, infra/billing/**, infra/entitlements/**
|
every job except web and gradle-wrapper |
tests/e2e/** |
python, e2e |
tests/e2e-web/** |
web, compose, e2e-web, e2e-demo |
LICENSE, LICENSING.md, LICENSES/** (copied into every image) |
docs and the image and stack jobs |
| anything else | every job |
The authoritative list is RULES in ci_scope.py (first match wins); tools/repo-checks/tests/test_ci_scope.py tests it, including the fail-safe cases.
Fail safe. A path no rule knows runs every job. A failed changes job leaves its outputs empty, and since the jobs only skip on an explicit false, they all run. When ci.yml itself changes, the script compares the two versions job by job (with the YAML anchors resolved, so a changed shared step counts for every job that uses it): a changed job runs, a change outside jobs (on, env, permissions, concurrency) or of a job it does not know runs everything.
ci-config runs on every pull request: actionlint (pinned release, checked against its SHA-256; it runs shellcheck on every run: block), shellcheck of the CI shell scripts, and, when the python job is skipped, ruff, mypy and the tests of tools/repo-checks, which check the workflows, Dependabot, the release configuration and the other repository conventions. When the python job runs, it runs those tests itself.
The jobs that start the Compose stack (camera-relay-media, e2e, e2e-web, e2e-demo) build the images from the cache the docker job fills. They wait for it (and for python or web) when those run, and also run when those are skipped, for example when only their own definition in ci.yml changed.
The branch ruleset of main requires python, openfga-model, docs, web, compose, helm, docker, camera-relay-media, e2e and e2e-web from this workflow (plus review / dependency-review, the Socket Security checks and CodeQL, which are not scoped). GitHub counts a job skipped by its if: as passed, so a skipped required job does not block the merge. A workflow that does not start at all (a paths filter under on:) would leave its required checks pending forever, which is why ci.yml has no paths filter and always starts; test_ci_scope.py keeps it that way. e2e-web, which merges the shard reports, is skipped together with its shards when the suite is not needed and still fails when a needed shard failed or was skipped.
Other workflows that only matter for some paths keep their own paths filter, because none of them is a required check: helm-kind.yml (the chart), fuzzing.yml (fuzzed code), mirror-images.yml (the image list).
A pull request that only changes CI configuration releases nothing (details in Releases): Dependabot's GitHub Actions and ClusterFuzzLite bumps are ci: commits, fix(ci): is not a release type in .releaserc.json, and the release workflow skips a release whose changes since the last tag are CI configuration only.
Mirrored from docs/dev/ci.md at commit ea8b3955b591ac0393dfcfda93ecacdeb6b8f1c3. Edit the file in the repository, not this wiki page.
Mirrored from the docs/ directory at commit ea8b3955b591ac0393dfcfda93ecacdeb6b8f1c3. Edit the files in the repository, not this wiki.
MowDeck documentation
- Home
- Phases
- Architecture
-
Decisions (ADR)
- Architecture decisions
- ADR 0001: OpenFGA instead of self-built authorization
- ADR 0002: Self-built Identity service in FastAPI instead of Keycloak or Zitadel
- ADR 0003: SvelteKit for the web app
- ADR 0004: Monorepo with a uv workspace
- ADR 0005: AGPL-3.0 for services and apps, Apache-2.0 for libraries
- ADR 0006: PostgreSQL for all persistence, no SQLite
- ADR 0007: NATS JetStream as event bus
- ADR 0008: Traefik as gateway
- ADR 0009: Command and event envelopes, subject naming and de-duplication
- ADR 0010: Python 3.13 for all services and libraries
- ADR 0011: Separate GPL-3.0 package for the PyMammotion adapter
- ADR 0012: Mower control interface and safety rules
- ADR 0013: Device-Gateway registry, sharding and per-mower concurrency
- ADR 0014: Authorization model, tuple ownership and the mowdeck-authz client
- ADR 0015: Tokens, sessions and key rotation
- ADR 0016: Fleet commands and authorization per command kind
- ADR 0017: Telemetry storage and retention
- ADR 0018: Realtime WebSocket protocol
- ADR 0019: Mammotion adapter transports, manual drive and secrets
- ADR 0020: Web app architecture
- ADR 0021: Browser authentication flow
- ADR 0022: Notifications: rules, recipients and delivery
- ADR 0023: Map rendering and projection
- ADR 0024: Scheduler: recurrence, rain pause and command issuing
- ADR 0025: Home Assistant integration as a pure API client
- ADR 0026: Manual drive channel over the Realtime WebSocket
- ADR 0027: Health history and theft alarm
- ADR 0028: Entitlements: plans as data and enforcement
- ADR 0029: Helm chart and release pipeline
- ADR 0030: Mowing patterns as plug-ins and the Planner
- ADR 0031: Billing with a Stripe adapter
- ADR 0032: Live camera over Agora, joined directly by the browser
- ADR 0033: Vision-assisted recovery with human approval
- ADR 0034: Linked cloud accounts and device discovery
- ADR 0035: Server-side camera frames and automatic AI analysis on errors
- ADR 0036: Native app shells with Capacitor, loading the web app from the server
- ADR 0037: Camera panorama calibration in the browser, with the AI supplying points only
- ADR 0038: Dual link per mower and firmware updates
- ADR 0039: Spot mowing by MowDeck-driven paths
- ADR 0040: Link heartbeat for online status
- ADR 0041: Spot runs from the dock: undock, transit and return
- ADR 0042: Drive calibration
- ADR 0043: Turn styles
- ADR 0044: Drive view with camera
- ADR 0045: Camera relay
- ADR 0046: Device settings as capabilities
- ADR 0047: The RTK base station as a Fleet device
- ADR 0048: Maintenance commands
- ADR 0049: Manual driving over the Mammotion cloud
- ADR 0050: Passkeys and the app login hand-off
- ADR 0051: Sign in with GitHub
- ADR 0052: Sign in with Apple
- ADR 0053: Retention and downsampling of the position track
- ADR 0054: Aerial photo under the mower map
- ADR 0055: Deploy maintenance window
- ADR 0056: Camera photo in push notifications for errors and theft alarms
- ADR 0057: Step-up re-authentication for critical actions
- ADR 0058: Theft tracking mode
- ADR 0059: iOS widgets and the mowing Live Activity
- ADR 0060: Apple Watch app
- ADR 0061: Mowing angle rotation
- ADR 0062: Setup tour for new users
- ADR 0063: Matter server (mowers in Apple Home and Google Home)
- ADR 0064: Personal access tokens and the public API documentation
- ADR 0065: Security center and new-login alerts
- ADR 0066: Cloud provider plugins and adapters for more vendors
- ADR 0067: Error code lexicon, provider independent
- ADR 0068: Public demo mode
- ADR 0069: Provider conformance kit and provider package template
- ADR 0070: Virtual zones for mowers without a vendor map
- ADR 0071: Capability matrix generated from the adapters
- ADR 0072: API explorer in the web app, for the public demo
- ADR 0073: Guided tour with coach marks
- ADR 0074: NATS authentication and per-service subject permissions
- ADR 0075: Chat control as an optional assistant add-on
- ADR 0076: Demo sandboxes, one account per visitor
- ADR 0077: Liveness, readiness and routing
- ADR 0078: Batched state ingestion
- ADR 0079: Fast demo sandbox claim and release
-
Development
- Getting started
- Service template
- Shared libraries
- Cloud providers: adding a vendor
- Adding a provider: template and conformance kit
- Adding an error lexicon for a vendor
- Design: identity and authorization
- Design: fleet, telemetry, realtime
- Design: web app
- Web app
- Home Assistant integration
- Camera source bridge protocol
- Fuzzing and property-based tests
- CI and pull request scope
- GitHub wiki mirror
-
Operations
- Operating the Compose stack
- Operating MowDeck on Kubernetes (Helm)
- Building the Bluetooth bridge (ESPHome on a XIAO ESP32-S3)
- Releases
- Vendor library updates
- Billing operations
- Telemetry: retention and position downsampling
- iPhone and Android apps
- Passkeys
- Sign in with GitHub
- Aerial photo under the map
- Sign in with Apple
- Theft tracking mode
- Matter server
- Chat control (assistant add-on)
- Source code offer (AGPL-3.0 section 13)
- Public demo
- Load testing
- Spikes
-
Guides
- Guides
- ESP32 bridge: purchase and setup
- Signing in with a passkey
- Signing in with GitHub
- Error codes in plain words
- Aerial photo under the map
- Signing in with Apple
- Confirming critical actions
- Your security page
- iPhone widgets and the mowing Live Activity
- Apple Watch
- The setup tour
- Apple Home and Google Home (Matter)
- Chat control
- Worx Landroid, Kress and LandXcape mowers
- Scripting MowDeck
- Capability matrix
- API reference
- Original plan (German)