minor: make it easy to know what to run to update CI_*_description.md files

Thomas Morinrequested to merge
easily-find-generate_ci_options_doc.py into main

This MR fixes a minor annoyance: today when CI fails on the pre-commit which checks that CI_*_description.md files are up-to-date, nothing is telling the user what to run to fix this.

Example: https://gitlab.com/sylva-projects/sylva-elements/ci-tooling/ci-deployment-values/-/jobs/14782124047

This MR:

  • adds a header to these files to explain how to regenerate them
  • rename the pre-commit hook to include tools/generate_ci_options_doc.py
Edited by Thomas Morin

Merge request reports