Skip to content

Commit

Permalink
Add validate action to validate api docs
Browse files Browse the repository at this point in the history
Signed-off-by: Pratik <pratikgparikh@gmail.com>
  • Loading branch information
pratik-parikh01 committed Oct 8, 2024
1 parent 5e59a64 commit 3f4ec64
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ jobs:
- lint
- validate-vendor
- validate-git
- binaries
steps:
-
name: Checkout
Expand All @@ -36,3 +37,13 @@ jobs:
make ${{ matrix.target }}
env:
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

0 comments on commit 3f4ec64

Please sign in to comment.