From 771aecbf757b0b879675ca3f73d76c69367a3119 Mon Sep 17 00:00:00 2001 From: Geethapranay1 Date: Tue, 24 Feb 2026 14:18:24 +0530 Subject: [PATCH 1/2] Move reference_results.metadata into reference-results directory fixes #537 Moved reference_results.metadata from tutorial root into the reference-results/ directory to colocate it with the .tar.gz files it describes. Changes: - moved metadata files into reference-results/ for all tutorials - updated generate_reference_results.py to write to new location - updated gitHub workflow git add pattern to match new location --- .github/workflows/generate_reference_results_workflow.yml | 2 +- changelog-entries/537.md | 1 + .../{ => reference-results}/reference_results.metadata | 0 .../{ => reference-results}/reference_results.metadata | 0 .../{ => reference-results}/reference_results.metadata | 0 .../{ => reference-results}/reference_results.metadata | 0 tools/tests/generate_reference_results.py | 5 +++-- 7 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 changelog-entries/537.md rename elastic-tube-1d/{ => reference-results}/reference_results.metadata (100%) rename flow-over-heated-plate/{ => reference-results}/reference_results.metadata (100%) rename multiple-perpendicular-flaps/{ => reference-results}/reference_results.metadata (100%) rename perpendicular-flap/{ => reference-results}/reference_results.metadata (100%) diff --git a/.github/workflows/generate_reference_results_workflow.yml b/.github/workflows/generate_reference_results_workflow.yml index f3677612d..4b647ba97 100644 --- a/.github/workflows/generate_reference_results_workflow.yml +++ b/.github/workflows/generate_reference_results_workflow.yml @@ -64,7 +64,7 @@ jobs: git checkout ${{ inputs.from_ref }} git add ./*/*/*.tar.gz git add ./*/*.tar.gz - git add ./*/*.metadata + git add ./*/reference-results/*.metadata git commit -m "${{inputs.commit_msg}}" git push - name: Upload artifacts for debugging diff --git a/changelog-entries/537.md b/changelog-entries/537.md new file mode 100644 index 000000000..9adfb27db --- /dev/null +++ b/changelog-entries/537.md @@ -0,0 +1 @@ +- Moved `reference_results.metadata` into the `reference-results/` directory for each tutorial, colocating it with the reference result archives it describes. #537 diff --git a/elastic-tube-1d/reference_results.metadata b/elastic-tube-1d/reference-results/reference_results.metadata similarity index 100% rename from elastic-tube-1d/reference_results.metadata rename to elastic-tube-1d/reference-results/reference_results.metadata diff --git a/flow-over-heated-plate/reference_results.metadata b/flow-over-heated-plate/reference-results/reference_results.metadata similarity index 100% rename from flow-over-heated-plate/reference_results.metadata rename to flow-over-heated-plate/reference-results/reference_results.metadata diff --git a/multiple-perpendicular-flaps/reference_results.metadata b/multiple-perpendicular-flaps/reference-results/reference_results.metadata similarity index 100% rename from multiple-perpendicular-flaps/reference_results.metadata rename to multiple-perpendicular-flaps/reference-results/reference_results.metadata diff --git a/perpendicular-flap/reference_results.metadata b/perpendicular-flap/reference-results/reference_results.metadata similarity index 100% rename from perpendicular-flap/reference_results.metadata rename to perpendicular-flap/reference-results/reference_results.metadata diff --git a/tools/tests/generate_reference_results.py b/tools/tests/generate_reference_results.py index f43866745..dfb3c8ea2 100644 --- a/tools/tests/generate_reference_results.py +++ b/tools/tests/generate_reference_results.py @@ -1,4 +1,3 @@ - import argparse from metadata_parser.metdata import Tutorials, ReferenceResult from systemtests.TestSuite import TestSuites @@ -142,7 +141,9 @@ def main(): # write readme for tutorial in reference_result_per_tutorial.keys(): - with open(tutorial.path / "reference_results.metadata", 'w') as file: + reference_results_dir = tutorial.path / "reference-results" + reference_results_dir.mkdir(parents=True, exist_ok=True) + with open(reference_results_dir / "reference_results.metadata", 'w') as file: ref_results_info = render_reference_results_info( reference_result_per_tutorial[tutorial], build_args, current_time_string) logging.info(f"Writing results for {tutorial.name}") From 48469de1a31b5a197e2d0854227ce6e28af71eab Mon Sep 17 00:00:00 2001 From: Geethapranay1 Date: Thu, 26 Feb 2026 15:47:24 +0530 Subject: [PATCH 2/2] style: autopep8 fixes from pre-commit --- tools/tests/generate_reference_results.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/tests/generate_reference_results.py b/tools/tests/generate_reference_results.py index dfb3c8ea2..055e7b31c 100644 --- a/tools/tests/generate_reference_results.py +++ b/tools/tests/generate_reference_results.py @@ -142,7 +142,7 @@ def main(): # write readme for tutorial in reference_result_per_tutorial.keys(): reference_results_dir = tutorial.path / "reference-results" - reference_results_dir.mkdir(parents=True, exist_ok=True) + reference_results_dir.mkdir(parents=True, exist_ok=True) with open(reference_results_dir / "reference_results.metadata", 'w') as file: ref_results_info = render_reference_results_info( reference_result_per_tutorial[tutorial], build_args, current_time_string)