dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 42 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: point markdown backlogs at Gitea issues (status lives in Gitea)

Browse Source
This commit is contained in:
Joseph Doherty
2026-11-06 15:31:44 -05:00
parent 10c04a23d7
commit 0e89966da6
9 changed files with 75 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+7
View File
@@ -237,6 +237,13 @@ spec for each is `docs/requirements/Component-<Name>.md`, and `README.md` carrie
- Script trust model: forbidden APIs (System.IO, Process, Threading, Reflection, raw network). **One host-mediated exception (2026-09-28):** site scripts get a read-only `Files` global (`ReadTextAsync`/`ReadLinesAsync`/`ExistsAsync`) that reads only beneath `ScadaBridge:SiteRuntime:ScriptFileAccess:AllowedRoots` — **off by default** (empty ⇒ every call throws `ScriptFileAccessException(Disabled)`), canonical-path directory-boundary match, no symlinks/junctions below a root, `MaxFileBytes` cap (1 MiB). The script still never names a `System.IO` type; errors are the Commons `ScriptFileAccessException`, and `Commons.Types.Scripts` is now a default script import on every surface. Not on inbound (central) scripts; the Test Run sandbox binds it but refuses. Design: `docs/plans/2026-09-28-script-file-access-design.md`. The trust boundary is centralized in the Script Analysis component (#25) — `ScriptTrustPolicy` is the single source of truth; all four call sites (Template Engine, Site Runtime, Inbound API, Central UI) delegate to `ScriptTrustValidator`. The design-time deploy gate in Template Engine is authoritative (real semantic compile), not advisory. Every Roslyn script-compile surface must also attach the shared `CachingScriptMetadataResolver.Instance` (ScriptAnalysis) via `ScriptOptions.WithMetadataResolver` — the four today are Site Runtime `ScriptCompilationService`, Inbound API `InboundScriptExecutor`, Central UI `ScriptAnalysisService`, and ScriptAnalysis `RoslynScriptCompiler`; a new surface that omits it silently reintroduces a per-compile native metadata leak (see Component-ScriptAnalysis.md).
- Application-level correlation IDs on all request/response messages.
## Backlog / open work
- Open work lives in Gitea issues: `tea issues list --repo dohertj2/ScadaBridge` (items migrated from markdown on 2026-11-06 carry the `migrated` label).
- Markdown backlogs are historical records with `→ #N` pointers, not status trackers: `docs/plans/2026-07-08-deferred-work-register.md` (register row numbers stay as permanent IDs cited from code), `archreview/plans/PLAN-R2-08-conventions-hygiene.md` + `00-MASTER-TRACKER.md`, `docs/known-issues/*.md`, the deployment records' *Outstanding* sections, and the tracked follow-ups in `docs/requirements/Component-ConfigurationDatabase.md`.
- Do not add new register rows. File new follow-ups, deferrals and review findings as issues with the family labels `type:{bug,feature,followup,review-finding,deploy-gate,debt,docs,test,infra}`, `priority:p0..p3`, `blocked`, `cross-repo`.
- Reference issues from plans and docs as `#N` (cross-repo: `scadaproj#N`, `mxaccessgw#N`).
## Tool Usage
- When a task requires setting up or controlling system state (sites, templates, instances, data connections, deployments, security, etc.) and the Central UI is not needed, prefer the ScadaBridge CLI over manual DB edits or UI navigation. See [`src/ZB.MOM.WW.ScadaBridge.CLI/README.md`](src/ZB.MOM.WW.ScadaBridge.CLI/README.md) for the full command reference.