Move reference_results.metadata into reference-results/ directory (#721)

fixes #537

Author: Geethapranay1

.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

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

…astic-tube-1d/reference_results.metadata …rence-results/reference_results.metadataelastic-tube-1d/reference_results.metadata renamed to elastic-tube-1d/reference-results/reference_results.metadata elastic-tube-1d/reference_results.metadata renamed to elastic-tube-1d/reference-results/reference_results.metadata

@@ -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}")