docs(docs): gate stages (drift, advisories), native exposure note, CI target wording, check:all in WORKSPACE and TEST_STRATEGY
This commit is contained in:
1 parent
e58c7be362
commit
073b25e52b
4 files changed
+27
-10
No files matched your search
@@ -91,6 +91,14 @@ separate caches; neither invalidates the other.
|
|||||||
uses; it is not needed for a compile or a test on the development
|
uses; it is not needed for a compile or a test on the development
|
||||||
machine.
|
machine.
|
||||||
|
|
||||||
|
Exposure change, stated for the record: a native build runs the build
|
||||||
|
scripts and proc-macros of the dependencies under the user account (the
|
||||||
|
builder container ran them with the repository mounted read-write, so the
|
||||||
|
difference is the rest of the home directory). Mitigations in place:
|
||||||
|
`--locked` everywhere, `deny.toml` `[sources]` limited to crates.io with
|
||||||
|
unknown registries and git sources denied, `cargo deny check licenses bans
|
||||||
|
sources` in every check.
|
||||||
|
|
||||||
## 2. Workspace
|
## 2. Workspace
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -203,7 +211,10 @@ pnpm check:all # scripts/check-all.sh, stops at the first failure
|
|||||||
```
|
```
|
||||||
|
|
||||||
Stages, in order: `scripts/rust-check.sh` (native), the ts-rs types drift
|
Stages, in order: `scripts/rust-check.sh` (native), the ts-rs types drift
|
||||||
(`git diff --exit-code -- packages/core-wasm/types`), `scripts/wasm-build.sh`
|
(`git status --porcelain -- packages/core-wasm/types` must be empty: a
|
||||||
|
modified or a new type file both fail), `cargo deny check advisories`
|
||||||
|
(warn-only: out of the blocking path by design, review VIII.3, but printed
|
||||||
|
here because no nightly job runs yet; needs the network), `scripts/wasm-build.sh`
|
||||||
(native), `pnpm check` (typecheck, tests including the `core-wasm` proofs on
|
(native), `pnpm check` (typecheck, tests including the `core-wasm` proofs on
|
||||||
the module just built and the pgTAP suite on PGlite, lint, build), the
|
the module just built and the pgTAP suite on PGlite, lint, build), the
|
||||||
application image, `pnpm worker:test` (sandbox tests and seccomp derivation
|
application image, `pnpm worker:test` (sandbox tests and seccomp derivation
|
||||||
@@ -235,8 +246,8 @@ same scripts:
|
|||||||
`faunosteo_worker:<sha>` and print their digests. Deploys nothing
|
`faunosteo_worker:<sha>` and print their digests. Deploys nothing
|
||||||
(DEPLOY.md "Image deploy by digest").
|
(DEPLOY.md "Image deploy by digest").
|
||||||
|
|
||||||
Target of the future CI/CD step (not implemented, recorded so the scripts
|
Target of the future CI/CD step (planned, not yet built; recorded so the
|
||||||
stay compatible): tests on every push and pull request, Rust and
|
scripts stay compatible): tests on every push and pull request, Rust and
|
||||||
TypeScript checks, PostgreSQL/RLS tests, Docker builds, security checks,
|
TypeScript checks, PostgreSQL/RLS tests, Docker builds, security checks,
|
||||||
branch verification before a merge, image publication only in an
|
branch verification before a merge, image publication only in an
|
||||||
explicitly authorised workflow.
|
explicitly authorised workflow.
|
||||||
|
|||||||
@@ -1011,7 +1011,7 @@ and VIII.4 and are implemented on `feature/rust-r0-foundation`:
|
|||||||
workflow is never reported as passed before it has run on the forge. The
|
workflow is never reported as passed before it has run on the forge. The
|
||||||
pre-merge gate is local: `pnpm check:all` (`scripts/check-all.sh`), which a
|
pre-merge gate is local: `pnpm check:all` (`scripts/check-all.sh`), which a
|
||||||
future runner calls as is.
|
future runner calls as is.
|
||||||
- Target of that future step (not implemented): tests on every push and pull
|
- Target of that future step (planned, not yet built): tests on every push and pull
|
||||||
request, Rust and TypeScript checks, PostgreSQL/RLS tests, Docker builds,
|
request, Rust and TypeScript checks, PostgreSQL/RLS tests, Docker builds,
|
||||||
security checks, branch verification before a merge, image publication
|
security checks, branch verification before a merge, image publication
|
||||||
only in an explicitly authorised workflow.
|
only in an explicitly authorised workflow.
|
||||||
|
|||||||
@@ -76,12 +76,17 @@ Target after Step 1: roughly 230–250 cases, all current ones untouched.
|
|||||||
- Golden PDFs are compared by extracted text and attachment JSON, not by
|
- Golden PDFs are compared by extracted text and attachment JSON, not by
|
||||||
bytes (pdf-lib dates and ids vary); raster hash only on fixed-size inputs.
|
bytes (pdf-lib dates and ids vary); raster hash only on fixed-size inputs.
|
||||||
|
|
||||||
## 5. CI gates
|
## 5. Gates before a merge, and the CI target
|
||||||
|
|
||||||
Per PR: `pnpm typecheck`, `pnpm lint` (0 warnings), `pnpm test:run`,
|
Today (2026-10-13) no CI runs on the forge; the gate is run on the
|
||||||
`pnpm build`; when `supabase/` changes: `supabase db reset`, `supabase test
|
development machine: `pnpm check:all` (`docs/development/RUST.md` §4) before
|
||||||
db`, types diff. Nightly: Playwright suite. Release: full RLS matrix,
|
every merge, plus `supabase db reset`, `supabase test db` and the types diff
|
||||||
backup/restore rehearsal checklist, `pnpm audit`, secret scan.
|
when `supabase/` changes. The workflow files under `.gitea/workflows/` are
|
||||||
|
prepared for a future runner and call the same scripts.
|
||||||
|
|
||||||
|
CI target (planned): per PR the stages of `pnpm check:all`; nightly the
|
||||||
|
Playwright suite and `cargo deny check advisories`; at release the full RLS
|
||||||
|
matrix, the backup/restore rehearsal checklist, `pnpm audit`, a secret scan.
|
||||||
|
|
||||||
## 6. Numbers to track
|
## 6. Numbers to track
|
||||||
|
|
||||||
|
|||||||
@@ -92,7 +92,8 @@ works as `corepack pnpm <cmd>`.
|
|||||||
| `pnpm test` | vitest watch for `apps/app` |
|
| `pnpm test` | vitest watch for `apps/app` |
|
||||||
| `pnpm lint` | ESLint, 0 warnings, in every package |
|
| `pnpm lint` | ESLint, 0 warnings, in every package |
|
||||||
| `pnpm build` | typecheck + Vite build in every package |
|
| `pnpm build` | typecheck + Vite build in every package |
|
||||||
| `pnpm check` | typecheck, test:run, lint, build in sequence (what CI runs) |
|
| `pnpm check` | typecheck, test:run, lint, build in sequence (the Node gate) |
|
||||||
|
| `pnpm check:all` | the whole pre-merge gate: native Rust check, types drift, wasm build, `pnpm check`, application and worker images (`docs/development/RUST.md` §4; no CI runs it yet) |
|
||||||
| `pnpm format` | Prettier on the whole repository |
|
| `pnpm format` | Prettier on the whole repository |
|
||||||
|
|
||||||
Package-scoped: `pnpm --filter @faunosteo/app <script>`.
|
Package-scoped: `pnpm --filter @faunosteo/app <script>`.
|
||||||
|
|||||||
Reference in new issue
Block a user