Workspace and lock contracts - Design model

Platform spec article

Workspace and lock contracts - Design model

Back to Workspace and lock contracts ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (3)

1. 0001-feature-hub-authority Feature hub authority Accepted

   This feature hub owns normative MUST/SHOULD contract text for Workspace and lock contracts.

   Context

   Sibling articles under this feature previously restated requirements in inconsistent forms.

   Decision

   This feature hub owns normative MUST/SHOULD contract text. Sibling articles must not redefine hub requirements and should link here for authority.

   Consequences

   Contract changes start on the hub or in linked ADRs, then propagate to articles and implementation anchors.

   Verification anchors

   • site/website/src/content/docs/platform-spec/compiler/resolution-and-projects/workspace-and-lock-contracts/index.mdx
   • article bundle under the same feature directory.

   Open full ADR page

2. 0002-spec-over-implementation-notes Specification over implementation notes Accepted

   Platform-spec text supersedes informal crate comments for Workspace and lock contracts.

   Context

   Implementation crates accumulated informal notes that diverged from published contracts.

   Decision

   Normative platform-spec prose and ADRs under this feature supersede informal comments in implementation crates until explicitly migrated into spec text.

   Consequences

   Engineers file spec/ADR updates when behavior changes; crate comments are non-authoritative for conformance arguments.

   Verification anchors

   • compiler/crates/beskid_analysis/src/resolve/mod.rs
   • compiler/crates/beskid_cli/src/commands/
   • compiler/crates/beskid_tests/src/projects/corelib/compile.rs

   Open full ADR page

3. 0003-lockfile-pins-resolution Lockfile pins drive resolution Accepted

   Floating registry versions broke reproducible compiles.

   Context

   Floating registry versions broke reproducible compiles.

   Decision

   Workspace resolution must honor lockfile pins from beskid_analysis::resolve before applying CLI overrides.

   Consequences

   Lock update commands are explicit; silent refresh is forbidden in CI modes.

   Verification anchors

   • compiler/crates/beskid_analysis/src/resolve/mod.rs
   • compiler/crates/beskid_cli/src/commands/.

   Open full ADR page

Articles

• Workspace and lock contracts - Contracts and edge cases Compiler guarantees for lock-backed graphs and workspace layout invariants. article Standard
• Workspace and lock contracts - Design model Compiler entities for workspace roots and lock materialization (workspace key prose defers to tooling). article Standard
• Workspace and lock contracts - Examples Gives concrete newcomer-friendly scenarios mapped to real compiler paths. article Standard
• Workspace and lock contracts - FAQ and troubleshooting Answers common operator and contributor questions with practical next checks. article Standard
• Workspace and lock contracts - Flow and algorithm Compiler order of operations for workspace discovery, lock apply, and graph materialization. article Standard
• Workspace and lock contracts - Verification and traceability Shows how the team proves this feature works and where evidence lives. article Standard

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 2 SpecSection(s) · 2 H2 heading(s)

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  Workspace and lock contracts

  Parent feature hub

• Feature
  Workspace and lock contracts (tooling)

  defers-to — reserved/forbidden workspace keys and lockfile semantics

Resolution model (compiler)

Entity	Role
Workspace root	Anchor for member Project.proj discovery
Lock snapshot	Pinned dependency versions consumed when building the graph
Materialized package root	On-disk layout the resolver uses after lock apply

The compiler must treat lock-backed roots as authoritative for reproducible CI graphs. Ad-hoc workspace toggles that alter Mod policy without a spec bump are rejected at parse time in tooling; the compiler enforces the resulting graph only.

Schema authority

Reserved and forbidden Workspace.proj keys, defaultMember, and lock update semantics are defined in tooling / design model. This article does not duplicate those tables.

Code anchors

• compiler/crates/beskid_analysis/src/resolve/mod.rs
• compiler/crates/beskid_cli/src/commands/
• compiler/crates/beskid_tests/src/projects/corelib/layout.rs