feat(2.5.0): embed algorithm card tests, remove tests/algorithms/ sid… - #15
Merged
Conversation
…ecar
Breaking change. The sidecar location tests/algorithms/<card-id>.test.yaml
is REMOVED as a valid location for algorithm card tests. Every algorithm
card MUST now carry an embedded top-level tests array with at least two
entries. Sidecar tests under tests/ remain valid for BPMN/DMN/CMMN
cornerstones; only algorithm cards are affected.
Rationale: the Algorithm Card viewer (new chapter 13.16) renders the
embedded tests as its primary interaction surface. A single source of
truth (the card file) makes the viewer self-contained and removes the
risk of orphaned tests or tests-without-card. The viewer minimum of
two cases is intentional: single-case sample browsers hide failure
modes and produce trivially-true UIs.
Changes:
- VERSION 2.4.0 -> 2.5.0
- algorithm-card.schema.json: new REQUIRED top-level tests array,
minItems: 2. Each entry has { name, description?, inputs,
expected_outputs, tolerance? }.
- specification/13-algorithm-cards.md: 13.12 rewritten (embedded
tests, sidecar REMOVED for algorithm cards); 13.11 promoted to
first-class; new 13.15 (migration guide from v2.4.0); new 13.16
(informative — Algorithm Card viewer contract: polymorphic on
implementation.type, common metadata/IO header, common sample-
browser footer, per-language inline visualisers, side-panel drawer
click-through from BPMN overlay).
- specification/11-semantic-validation.md: SEM-014 (ERROR — tests
array MUST have >=2 entries) + SEM-015 (WARN — test input/output
keys SHOULD match io.inputs/outputs ids).
- specification/10-conformance-checklist.md: three new bullets for
SEM-014, SEM-015, and the sidecar removal.
- examples/approve-expense-l4: card gains two embedded tests; old
tests/algorithms/policy_lookup_assistant.test.yaml sidecar deleted;
archive re-packed.
- CHANGELOG.md: v2.5.0 entry stating the breaking change plainly.
uapf-cli validates both examples cleanly against v2.5.0 schemas.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…ecar
Breaking change. The sidecar location tests/algorithms/.test.yaml is REMOVED as a valid location for algorithm card tests. Every algorithm card MUST now carry an embedded top-level tests array with at least two entries. Sidecar tests under tests/ remain valid for BPMN/DMN/CMMN cornerstones; only algorithm cards are affected.
Rationale: the Algorithm Card viewer (new chapter 13.16) renders the embedded tests as its primary interaction surface. A single source of truth (the card file) makes the viewer self-contained and removes the risk of orphaned tests or tests-without-card. The viewer minimum of two cases is intentional: single-case sample browsers hide failure modes and produce trivially-true UIs.
Changes:
uapf-cli validates both examples cleanly against v2.5.0 schemas.