Skip to content

Commit 71c3b56

Browse files
committed
📝 docs(sdk): extending the seam golden TDR to collectors-sdk and injectors-sdk
1 parent f5e7ce3 commit 71c3b56

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

‎libs/xtm-oaev-sdk/CONTRIBUTING.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@ on it
8787

8888
No list to maintain. The next run picks up any new seam object.
8989

90+
collectors-sdk and injectors-sdk carry the same golden under their own `test/seam/`. There,
91+
run the generator from `libs/<sdk>`: `python test/seam/generate_seam_golden.py`.
92+
9093
### What a fingerprint covers
9194

9295
The sha256 of the definition's normalized AST. Formatting, comments and docstrings do

‎libs/xtm-oaev-sdk/docs/tdr/every-seam-object-is-fingerprinted.tdr.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Every seam object is fingerprinted
22
---
3-
scope: [xtm-oaev-sdk, seam, testing, versioning]
3+
scope: [xtm-oaev-sdk, collectors-sdk, injectors-sdk, seam, testing, versioning]
44
status: draft
55
superseded_by:
66
supersedes: cross-process-seams-pin-their-json-schemas
77
Aliases:
88
Creation Date: 2026/10/15 08:36:35
9-
Modification Date: 2026/10/15 08:36:35
9+
Modification Date: 2026/10/15 08:49:12
1010
---
1111

1212
## ELI5
@@ -42,6 +42,7 @@ version and save the new fingerprint.
4242
- It rewrites `test/seam/fixtures/seam_golden.json`: changed fingerprints updated, new objects added, deleted ones removed. It prints what moved, and warns when a capability changed but its version did not.
4343
- `test/seam/test_seam_golden.py` recomputes the fingerprints and fails on anything added, removed or changed, and names every object. It also checks that the package root re-exports the seam's own objects.
4444
- `test/seam/test_seam_closed.py` keeps the two closed-import checks: `port_io` imports only the signatures seam, and the signatures seam imports nothing from the SDK.
45+
- collectors-sdk and injectors-sdk carry the same generator and golden test under their own `test/seam/`, run from their `libs/<sdk>` directory.
4546
- The step-by-step procedure lives in `CONTRIBUTING.md`, "Seam golden".
4647

4748
---

0 commit comments

Comments
 (0)