ci: add validation for generated docs

[dvdksn]

Signed-off-by: David Karlsson david.karlsson@docker.com

- What I did

Added a step for validating the generated markdown/yaml files, based on the generation output vs what's checked in to the repo

closes#4171

- How I did it

Added a job to the validate GHA workflow

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

[dvdksn]

Well that failed spectacularly, love it

[dvdksn]

alright, seems to work. Do you want me to push a failing commit to verify? @thaJeztah

[thaJeztah]

Awesome! Let me also call in @crazy-max to check 🤗

[crazy-max]

LGTM

In follow-up it would be nice to be able to run it locally. Probably sandboxed with a Dockerfile like we do in buildx repo.

[codecov-commenter]

Codecov Report

Merging #4187 (5046967) into master (fff5a31) will decrease coverage by 0.18%.
The diff coverage is n/a.

Additional details and impacted files

@@ Coverage Diff @@## master #4187 +/- ##
==========================================
- Coverage 59.03% 58.85% -0.18% 
==========================================
Files 288 572 +284 Lines 24776 49540 +24764 ==========================================
+ Hits 14627 29158 +14531 - Misses 9265 18614 +9349 - Partials 884 1768 +884 

[thaJeztah]

Do we need the fetch-depth: 0 at line 33, or can that one also be removed?

If we need to keep it for that one, we should probably add a comment to explain "why" it's needed for that one (which may help prevent others copying that when creating new checks).

./cc @crazy-max

[thaJeztah]

micro-nit: this should probably be in the first commit (so that we don't add it in the first place 😄

[dvdksn]

sorted it out 😆

[crazy-max]

Do we need the fetch-depth: 0 at line 33, or can that one also be removed?

If we need to keep it for that one, we should probably add a comment to explain "why" it's needed for that one (which may help prevent others copying that when creating new checks).

./cc @crazy-max

It looks safe to remove 👍

[thaJeztah]

LGTM, thanks!