Add MAINTAINING.md - public distribution runbook for maintainers #5

Open
opened 2026-10-05 05:33:00 +00:00 by justin · 0 comments
Owner

Summary

Add MAINTAINING.md — the handover runbook for the public workbench distribution: how it works, how to ship an update, how to manage access, the traps that cost time to discover, and the known gaps.

Why

The distribution was set up on 2026-10-05. Nothing about it is self-evident from the code or the Forgejo UI — in particular that internal visibility is derived rather than settable, and that moving the repo back to cgg would silently make it unreachable again. Without a written record the next person will re-derive all of it.

Contents

  • Why the repo lives at comfac-dist and must not move back
  • End-to-end flow: InitGui.py -> MANIFEST_URL -> manifest.json -> release assets -> UserAppData/Mod
  • Routine jobs: shipping an updated workbench, adding a workbench, managing access, rolling back
  • Traps, each one verified against this instance rather than assumed
  • Known gaps, including that the updater does not update existing installs

Note

This is documentation only — no behaviour change. Documentation is deliberately free of internal filesystem paths and credential locations, since this repository is public.

## Summary Add `MAINTAINING.md` — the handover runbook for the public workbench distribution: how it works, how to ship an update, how to manage access, the traps that cost time to discover, and the known gaps. ## Why The distribution was set up on 2026-10-05. Nothing about it is self-evident from the code or the Forgejo UI — in particular that `internal` visibility is *derived* rather than settable, and that moving the repo back to `cgg` would silently make it unreachable again. Without a written record the next person will re-derive all of it. ## Contents - Why the repo lives at `comfac-dist` and must not move back - End-to-end flow: `InitGui.py` -> `MANIFEST_URL` -> `manifest.json` -> release assets -> `UserAppData/Mod` - Routine jobs: shipping an updated workbench, adding a workbench, managing access, rolling back - Traps, each one verified against this instance rather than assumed - Known gaps, including that the updater does not update existing installs ## Note This is documentation only — no behaviour change. Documentation is deliberately free of internal filesystem paths and credential locations, since this repository is public.
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
comfac-dist/ComfacCAD#5
No description provided.