elastic / elasticsearch

Free and Open Source, Distributed, RESTful Search Engine
https://www.elastic.co/products/elasticsearch
Other
1.26k stars 24.86k forks source link

CI Check for unchecked generated files, e.g., docs #116688

Open GalLalouche opened 6 days ago

GalLalouche commented 6 days ago

Description

In ES|QL, we have a bunch of generated doc files, e.g., docs/reference/esql/functions/description/bit_length.asciidoc. These files are currently generated when we run the relevant test, so for bit_length, they will be generated when we run BitLengthTests. While these files are auto-generated, they are tracked by git, so it would be nice if the CI could catch cases where the PR author forgot to run the tests and therefore update the docs, e.g., by checking if these files have changes compared to the committed version.

elasticsearchmachine commented 6 days ago

Pinging @elastic/es-analytical-engine (Team:Analytics)