Move reference results metadata into each archive#882
Open
PranjalManhgaye wants to merge 6 commits into
Open
Conversation
Store generation metadata inside each archive's case directory instead of writing one shared file per tutorial.
PranjalManhgaye
changed the title
github-project-automation
Bot
moved this to Planned next
in GSoC 2026: System tests improvements
PranjalManhgaye
moved this from Planned next
to Needs review
in GSoC 2026: System tests improvements
MakisH
reviewed
Jul 18, 2026
Rename the per-archive metadata file to reference-results-metadata.txt and add --ignore-missing-source-files so fieldcompare does not fail on the metadata when comparing against regenerated archives.
Replace --ignore-missing-source-files with --exclude-files reference-results-metadata.txt so only the embedded metadata is skipped and missing timesteps still fail comparison.
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
2 participants
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.
Summary
Store
reference-results-metadata.txtinside each archive's case directoryStop writing one shared metadata file per tutorial
Drop the SHA256 checksum from the metadata (it described the outer
.tar.gz, which no longer makes sense once the file lives inside that archive)Ignore the embedded metadata during field comparison
Rename the metadata file to
reference-results-metadata.txtso editors open it as plain textUpdate the system-test documentation
Closes #811
Test Plan
Packed sample archives locally and verified
reference-results-metadata.txtends up inside each case folder, with exports and iteration logs unchanged, and no shared metadata file written anymore. Also verified fieldcompare ignores the metadata file, and ran pre-commit on the changed files. Full regeneration of reference archives happens after merge, as discussed.