rest-for-physics / rest-for-physics/framework

Create a validation pipeline to check ROOT schema evolution is maintained.

Open
#167 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
19
Forks
14
PR merge metrics
No merged PRs in 30d

Description

When we generate a new official release, we should create a ROOT file that contains a dummy object of each class from each library. Then, any future pipeline should try to read the ROOT official release generated file and check that it is possible to open it without any warnings. Typical ROOT warnings when ClassDef version is not increased.

This will assure backwards compatibility.

We need a macro/code that lists all metadata classes (including processes), creates an instance of each, writes the default initialisation to disk, and places it to a common place. We do that for each official release.

Then, simply try to open each of the files available at common place, where each file corresponds to a previous official release.

@lobis @rest-for-physics/core_dev

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the framework's metadata classes, including process classes, and the existing release or pipeline entry points. Define how a macro or other code should create default instances, write one ROOT file per official release, and reopen prior release files without warnings; done means the validation covers all available release files and detects schema-evolution warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend, ci-cd, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.