feat(apidoc): Automatically generate and deploy API Documentation

opendatacam · Dec 21, 2020 · c1a83cd · c1a83cd
1 parent 6ff4c90
commit c1a83cd
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/.github/workflows/apidoc.yml b/.github/workflows/apidoc.yml
@@ -0,0 +1,26 @@
+name: API Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - test-api-documentation
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+
+      - name: Generate API Documentation
+        run: npm run generateapidoc
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: .build/apidoc