Update documentation on Crystalball
Context
#413510 (closed) led me to a deeper understanding of the Crystalball gem.
Goal
Share the knowledge found in the investigation above, and document it.
Subjects to cover:
- How we use it (i.e. mappings, no predictions)
- How do we transform the data in the CI jobs? (And why)
- How to run it locally, to see how it all works out, …
- How to see which predictions we would make in the CI with Crystalball, to understand whether another mapping would be necessary
- ...
Hints
We have documentation about Crystalball in several locations:
-
https://docs.gitlab.com/ee/development/pipelines
- Overview for the entire company - crosslinks to the RUNBOOK
-
https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/blob/main/runbooks/predictive-tests.md
- More detailed information for EP and people that want to make changes to the system
Edited by David Dieulivol