Skip to content

Commit the design of following SPINE releases, as built - #7

Merged
pgranger23 merged 1 commit into
mainfrom
docs/following-spine-releases
Nov 6, 2026
Merged

pgranger23 merged 1 commit into
mainfrom
docs/following-spine-releases

Conversation

@pgranger23

Copy link
Copy Markdown
Collaborator

This commits the design document behind pull requests 1 to 6, with two open points closed. Until now it was only in the author's working tree.

What changes

  • docs/designs/following-spine-releases.md (new) covers:

    • the library's version;
    • the tests that survive expected SPINE changes;
    • the fixture tooling for any tag;
    • the dumper's new keys;
    • the classifier and follow_spine.py;
    • CI.

    Its companion following-spine-releases.cafmaker-fields.tsv lists the 228 model fields the three CAFMakers read, from which tests/test_contracts.cpp was written.

  • Updated before committing:

    • Status: implemented in pull requests 1 to 6, with v0.1.0 on the merge commit of pull request 2.
    • G2 and the v1.4.91 row of the Verification Plan (open point R8): a new NuInteractionScheme member needs its interaction tables in SPINE's Neutrino.resolve_enum. Otherwise the dumper stops with cannot identify the enum of interaction_mode under ..., and follow_spine.py reports dump_failed.
    • The table of open points R1–R16 gains a column saying how each was fixed.
    • A new section, "As built", records where the code differs from the plan, pull request by pull request, and what the verification reached. Where the two differ, that section is right.
  • The root EGM.md and the README index the new docs/ folder.

No code changes.

Checked

  • The R8 sentence: a dump of a copy of SPINE v1.4.0 with NuInteractionScheme.MARLEY and no tables exits 1 with dump_schema: RuntimeError: cannot identify the enum of interaction_mode under MARLEY: []. The local tag v1.4.91, which adds the tables, ran to changed in pull request 6's checks.
  • The document has no local paths; it names the author's local notes only as being outside the repository. The links from the README and EGM.md resolve.

docs/designs/following-spine-releases.md is the design that pull requests
1 to 6 implemented: the library's version, the tests that survive expected
SPINE changes, the fixture tooling for any tag, the dumper's new keys, the
classifier and follow_spine.py, and CI. Its companion
following-spine-releases.cafmaker-fields.tsv lists the 228 model fields the
three CAFMakers read, from which tests/test_contracts.cpp was written.

Updated before committing:
- Status: implemented, in pull requests 1 to 6; v0.1.0 on the merge
  commit of pull request 2.
- G2 and the v1.4.91 row (R8): a new NuInteractionScheme member needs its
  interaction tables in SPINE's Neutrino.resolve_enum, or the dumper stops
  with "cannot identify the enum of interaction_mode under ..."
  (checked on a copy of v1.4.0 with a member and no tables).
- The table of open points R1-R16 says how each was fixed.
- A new section, "As built", records where the code differs from the plan,
  pull request by pull request, and what the verification reached.

The root EGM.md and the README index the new folder.
@pgranger23
pgranger23 merged commit b0672f0 into main Nov 6, 2026
4 checks passed
@pgranger23
pgranger23 deleted the docs/following-spine-releases branch November 6, 2026 13:15
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