Skip to content

Add update experiment config docs and automated workflows - #66

Merged
jo-basevi merged 6 commits into
mainfrom
65-add-docs-for-updating-experiments
Aug 12, 2026
Merged

Add update experiment config docs and automated workflows#66
jo-basevi merged 6 commits into
mainfrom
65-add-docs-for-updating-experiments

Conversation

@jo-basevi

Copy link
Copy Markdown
Member

This PR:

  • Adds the update experiment config guide which is largely the contents of the issue Updating experiment info in the website experiment configuration #65
  • Adds a workflow sync_experiments.yml which automatically adds experiment UUIDs to the CMIP7 experiments table in the tracking services DB (so we can access the payu telemetry summary via the public endpoint for the dashboard).
  • Adds json schema and workflow for validating the experiment config file in pull requests.

The sync_experiments.yml workflow effectively just posts the json objects to tracking-services if there isn't already a UUID present in the table:

{
    "experiment_uuid": "16897734-4456-4279-91f9-b3389d6a7673",
    "experiment_name": "esm-historical-r27i1p1f1",
}

Previously the name was directory names in the synced location on NCI, but as the experiment_name isn't used anywhere currently, it can be changed. So now it'll use the name (+ the name for ensemble/related experiment) in the public/experiment-config.json.

I have tested the current public/experiment-config.json passes the schema check, and I've tested the python script for updating the DB on a local tracking-services instance.

TODO:

  • Add GitHub secrets for TS_API_BASE_URL and TS_API_TOKEN

@codecov

codecov Bot commented Aug 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.67%. Comparing base (82cd143) to head (1377f42).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #66   +/-   ##
=======================================
  Coverage   88.67%   88.67%           
=======================================
  Files          55       55           
  Lines        2553     2553           
  Branches      385      385           
=======================================
  Hits         2264     2264           
  Misses        289      289           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@charles-turner-1

Copy link
Copy Markdown
Collaborator

Looks good to me!

@jo-basevi
jo-basevi force-pushed the 65-add-docs-for-updating-experiments branch from d3bd6d7 to 1377f42 Compare August 12, 2026 05:27
@jo-basevi
jo-basevi merged commit 95c2fcb into main Aug 12, 2026
4 checks passed
@jo-basevi
jo-basevi deleted the 65-add-docs-for-updating-experiments branch August 12, 2026 05:35
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.

2 participants