Pipeline: Generate the readme and contents files instead of keeping them by hand - #155
Merged
ehennestad merged 2 commits intoSep 6, 2026
Conversation
…by hand The readme of each generated folder and the Contents.m listing a version's modules describe generated content, but were maintained by hand in the toolbox and copied over the build afterwards. Nobody remembered them when a model version was added: v4.0 and v5.0 had no Contents.m at all, only latest had readme files, and the Contents.m for latest had been missing neuroimaging since that module appeared. Both are derived from the schemas now and written with the classes they describe, so every version has them and they cannot drift. Applying a build is one copy again, with no second pass to restore anything. The generated files reproduce the hand-written ones exactly for v1.0, v2.0 and v3.0, and for the three readme files. latest differs by the module that was missing. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The readme for the types folder called the model a "metadata model". openMINDS uses that name one level down, for each of core, SANDS, controlledTerms and the rest, and calls the whole thing the openMINDS metadata framework. Using it for the model named the wrong scope. The enumerations readme said "the openMINDS models and metadata types", where the enumerations generated are Modules and Types. That looks like a slip for "modules", so it now names both, and the framework they belong to. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
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.
Stacked on #154.
The readme of each generated folder, and the
Contents.mlisting a model version's modules, describe generated content. They were kept by hand in the toolbox and copied over the build afterwards, which is a shape that only works if someone remembers them. Nobody did:Contents.mat alllatesthas readme filesContents.mforlatesthas been missingneuroimagingsince that module appearedBoth are derived from the schemas now and written with the classes they describe, so every version gets them and they cannot drift again. The
Contents.mmodule list is the same one that fills theModulesenumeration.Applying a build goes back to a single copy, with no second pass to restore anything, and the toolbox no longer needs to carry the sources.
What the text says
The generated
Contents.mreproduces the hand-written one byte for byte for v1.0, v2.0 and v3.0.latestdiffers by exactly the one missing module line.Two sentences in the readme files changed deliberately:
openMINDS uses "metadata model" one level down, for each of
core,SANDS,controlledTermsand the rest, and calls the whole thing the openMINDS metadata framework. Using it for the model named the wrong scope. The second is a slip: the enumerations generated areModulesandTypes, not models."Metadata type" stays. The documentation says "schema type", but this toolbox deliberately reserves "schema" for the schema file and says "type" for the openMINDS type, which is what
openminds.enum.TypesandgetTypeNameare named after. Qualifying it as "metadata type" matches the framework's own "metadata" family without reintroducing "schema".Follow-up in the toolbox
code/resources/content_filesandcode/resources/readme_filesbecome dead once this lands and can be deleted. That deletion is best done after #135, since it moves the same folders and a deletion againstmainwould conflict with it.🤖 Generated with Claude Code