1
0
mirror of https://github.com/distribution/distribution synced 2024-12-25 15:05:51 +01:00

Add validate action to validate api docs

Signed-off-by: Pratik <pratikgparikh@gmail.com>
This commit is contained in:
Pratik 2024-10-08 21:37:13 +05:30
parent 5e59a64896
commit 3f4ec64f71

@ -26,6 +26,7 @@ jobs:
- lint - lint
- validate-vendor - validate-vendor
- validate-git - validate-git
- binaries
steps: steps:
- -
name: Checkout name: Checkout
@ -36,3 +37,13 @@ jobs:
make ${{ matrix.target }} make ${{ matrix.target }}
env: env:
COMMIT_RANGE: ${{ format('{0}..{1}', github.sha, 'HEAD') }} COMMIT_RANGE: ${{ format('{0}..{1}', github.sha, 'HEAD') }}
-
name: Validate docs
if: matrix.target == 'binaries'
run: |
./bin/registry-api-descriptor-template ./docs/content/spec/api.md.tmpl > /tmp/api.md
echo "Ensure that you have run the following before pushing your commits:
make binaries
./bin/registry-api-descriptor-template ./docs/content/spec/api.md.tmpl > ./docs/content/spec/api.md"
diff docs/content/spec/api.md /tmp/api.md > /dev/null 2>&1