document ci options

closes sylva-projects/sylva-core#2199 (closed)

This MR adds a new pre-commit script tools/generate_ci_options_doc.py which aims to parse all CI values files stored in current repo in folders: common, current, private and all versions 1.6, 1.5..etc (new versions should be automatically detected without code change) and based on a central file values_metadatas.yml it builds 2 Markdown files:

In documentation file:

  • all ✅ are clickable and open the corresponding option file
  • ☑️ are not clickable: common values is applied
  • ❌: not value exists

This pre-commit will fail in following cases:

  • an option file exists but is not defined in central file
  • use of bad extension: .yaml ( only .yml is autorised)

Example of warning and error logs:

2026-03-04 13:30:14,491 - ERROR - 🚨 current/simple-update2.yml No metadata found for simple-update2
2026-03-04 13:30:56,503 - ERROR - 🚨 current/simple-update.yaml YAML file found, only YML files are supported
Edited by Alexandre Seitz

Merge request reports

Loading
Loading