Publish API docs (#1094)

Redirects I want eventually ( @Bankst ) demo.photonvision.org redirected to https://photonvision.github.io/photonvision/built-client/ javadocs.photonvision.org redirected to https://photonvision.github.io/photonvision/built-docs/javadoc/ cppdocs.photonvision.org redirected to https://photonvision.github.io/photonvision/built-docs/doxygen/html/ For now this runs on all commits to master. Once we confirm it works, let's pull back to only tagged releases --------- Co-authored-by: Mohammad Durrani <[email protected]> Co-authored-by: Chris <[email protected]>
PhotonVision · Jan 5, 2024 · b033f7e · b033f7e
1 parent 4d9f228
commit b033f7e
Show file tree

Hide file tree

Showing 11 changed files with 2,153 additions and 39 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -81,7 +81,7 @@ jobs:
       - name: Gradle Build
         run: |
           chmod +x gradlew
-          ./gradlew photon-server:build photon-lib:build -x check --max-workers 2
+          ./gradlew build -x check --max-workers 2
       - name: Gradle Tests
         run: ./gradlew testHeadless -i --max-workers 1 --stacktrace
       - name: Gradle Coverage

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,92 @@
+name: Documentation
+
+on:
+  push:
+    # For now, run on all commits to master
+    branches: [ master ]
+    # and also all tags starting with v
+    tags:
+      - 'v*'
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-client:
+    name: "PhotonClient Build"
+    defaults:
+      run:
+        working-directory: photon-client
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Install Dependencies
+        run: npm ci
+      - name: Build Production Client
+        run: npm run build-demo
+      - uses: actions/upload-artifact@v4
+        with:
+          name: built-client
+          path: photon-client/dist/
+
+  run_docs:
+    runs-on: "ubuntu-22.04"
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Fetch tags
+      run: git fetch --tags --force
+    - name: Install Java 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: 17
+        distribution: temurin
+
+    - name: Build javadocs/doxygen
+      run: |
+        chmod +x gradlew
+        ./gradlew docs:generateJavaDocs docs:doxygen
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: built-docs
+        path: docs/build/docs
+
+  release:
+    needs: [build-client, run_docs]
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-22.04
+    steps:
+
+      # Download literally every single artifact.
+      - uses: actions/download-artifact@v4
+
+      - run: find .
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: '.'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/README.md b/README.md
@@ -92,3 +92,10 @@ Our meeting notes can be found in the wiki section of this repository.
 
 * [2020 Meeting Notes](https://github.com/PhotonVision/photonvision/wiki/2020-Meeting-Notes)
 * [2021 Meeting Notes](https://github.com/PhotonVision/photonvision/wiki/2021-Meeting-Notes)
+
+## Documentation
+
+- Our main documentation page: [docs.photonvision.org](https://docs.photonvision.org)
+- Photon UI demo: [demo.photonvision.org](https://demo.photonvision.org) (or [manual link](https://photonvision.github.io/photonvision/built-client/))
+- Javadocs: [javadocs.photonvision.org](https://javadocs.photonvision.org) (or [manual link](https://photonvision.github.io/photonvision/built-docs/javadoc/))
+- C++ Doxygen  [cppdocs.photonvision.org](https://cppdocs.photonvision.org) (or [manual link](https://photonvision.github.io/photonvision/built-docs/doxygen/html/))