Skip to content

feat(resources): v2-only pinned course map schema and v1 retirement (WS-I03) - #6

Merged
christophersesugh merged 1 commit into
mainfrom
feat/ws-i03-resource-map-v2
Nov 16, 2026
Merged

christophersesugh merged 1 commit into
mainfrom
feat/ws-i03-resource-map-v2

Conversation

@christophersesugh

Copy link
Copy Markdown
Contributor

WS-I03 — active resource-map v2 contract

Implements the P0 WS-I03 source slice from Workspace Specification 0004. This is a v2-only breaking change with no historical compatibility code.

What changes

  • Replace active JSON Schema v1 with schemaVersion 2 and required canonical OEE v0.2.0 source identity (full lowercase Git SHA, repository, course code/path).
  • Support optional revision-scoped outcomeIds and assessmentIds, strict known-field checks, honest mapped/partial/unmapped gaps, catalogue identities, verification and part/lesson locators.
  • Fail closed when there is no independently selected pinned OEE Toolkit export; invoke the merged Workspace PR test(workspace): strict OEE pinned-export consumer contract (WS-I11 groundwork) #5 consumer for source/outcome/assessment comparisons when one is provided. Never fall back to moving OEE HEAD.
  • Retire the historical SEF1 v1 map and its stale generated guide from the active public paths. Preserve its exact original bytes in tests/fixtures/resource-map-v1-SEF1.json and Git history solely as a negative regression fixture. This is not an automatic curriculum migration.
  • Update mapped-guide safety, unmapped course scaffolding, public docs and resource CI, plus standard-library-only v2 tests.

Explicit non-goals and dependencies

  • WS-I01: automatic pinned Git-object resolution / complete source-map validation integration.
  • WS-I02: manually review and author a new SEF1 v2 resource map; do not carry chapters forward by index.
  • WS-I04: fully safe reviewed-guide publishing and mapped generation.
  • WS-I12: unrelated project alias/template hardening.
  • WS-I11: complete downstream contract CI, beyond its merged PR test(workspace): strict OEE pinned-export consumer contract (WS-I11 groundwork) #5 groundwork.

Review and verification

  • Resource checks: python3 scripts/check-resources.py (catalogue only while no active maps).
  • Contract tests: python3 -m unittest discover -s tests -p 'test_*.py' -v.
  • Stale guide check: python3 scripts/render-resource-guides.py --check.
  • Negative cases: v1 SEF1, old OEE spec, invalid SHA/source/path, missing gaps, duplicate resource identities, and malformed outcome/assessment IDs.
  • Existing pinned export consumer tests cover unknown IDs, mismatched source SHA, changed module/lesson locators and unsupported export versions.
  • Learner scaffolding must work without a mapped guide and never overwrite existing work.

Review gate: This commit is created by the connected GitHub integration and requires the legitimate contributor's DCO Signed-off-by: trailer. Please review, amend/sign locally and push before merge. This PR is left draft until checks and owner sign-off pass. Do not mark WS-I03 done until the PR is merged and acceptance evidence is recorded.

@christophersesugh
christophersesugh force-pushed the feat/ws-i03-resource-map-v2 branch 2 times, most recently from 2e5c0f1 to 295c40b Compare November 16, 2026 12:51
Replace schema v1 with v2-only pinned OEE v0.2.0 mapping, optional outcome/assessment references, and an independent export consumer gate. Archive legacy SEF1 as a negative fixture, remove its stale guide, and update tests, CI, generator and public docs. Reject pre-v0.2.0 course scaffolding; no v1 adapter or auto-remapping. WS-I01/WS-I02 remain separate.

Signed-off-by: Christopher S. Aondona <christohybrid185@gmail.com>
@christophersesugh
christophersesugh force-pushed the feat/ws-i03-resource-map-v2 branch from 295c40b to 2a7e68d Compare November 16, 2026 12:53
@christophersesugh
christophersesugh marked this pull request as ready for review November 16, 2026 12:53
@christophersesugh
christophersesugh merged commit 92bb0f7 into main Nov 16, 2026
4 checks passed
@christophersesugh
christophersesugh deleted the feat/ws-i03-resource-map-v2 branch November 16, 2026 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant