cicd: api reference check

commit adds a check to confirm api reference does not go stale Signed-off-by: ldelossa <ldelossa@redhat.com>
quay · Oct 1, 2020 · f04bc76 · f04bc76
1 parent 2c9762b
commit f04bc76
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -22,6 +22,19 @@ jobs:
           error: 'Commit must begin with <scope>: <subject>'
           flags: ''
 
+  api-reference-check:
+    name: API Reference Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: gen api reference 
+        run: |
+          npx widdershins --search false --language_tabs 'python:Python' 'go:Golang' 'javascript:Javascript' --summary ./openapi.yaml -o ./Documentation/reference/api.md
+      - name: diff
+        run: |
+          git diff --exit-code
+
   tidy:
     name: Tidy
     runs-on: ubuntu-latest