rework workflows and setup dispatch job

Author: cewert

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: build
+name: Test if build is working
 
 on:
   pull_request:

.github/workflows/gh-pages.yml .github/workflows/deploy.yml.github/workflows/gh-pages.yml renamed to .github/workflows/deploy.yml

@@ -3,9 +3,16 @@ name: gh-pages
 
 on:
   push:
-    branches: ["main"]
+    branches:
+      - main
     paths-ignore:
+      - '.github/workflows/build.yml'
+      - '.github/workflows/update.yml'
+      - '.gitignore'
+      - 'jsdoc.json'
+      - 'LICENSE'
       - 'README.md'
+      - 'renovate.json'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -23,7 +30,7 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  deploy:
+  run:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
@@ -36,7 +43,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
         with:
-          # Only upload the api docs folder
+          # Only upload the code docs folder
           path: "docs"
       - name: Deploy to GitHub Pages
         id: deployment

.github/workflows/update.yml

@@ -0,0 +1,38 @@
+name: Update code docs
+
+on:
+  repository_dispatch:
+    types: [code-update]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          ref: ${{ github.ref_name }}
+          token: ${{ secrets.JELLYROCK_BOT_TOKEN }}
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version: "lts/*"
+          cache: "npm"
+      - name: Install NPM dependencies
+        run: npm ci
+      - name: Checkout jellyrock
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          repository: cewert/jellyrock
+          path: jellyrock
+          ref: main
+      - name: Build code docs
+        # TODO: fix jsdoc build errors then remove '|| true' from run command below
+        run: npm run build || true
+      - name: Commit any changes
+        uses: stefanzweifel/git-auto-commit-action@778341af668090896ca464160c2def5d1d1a3eb0 # v6
+        with:
+          commit_message: Update code docs
+          # use JellyRock-bot to commit the changes instead of the default github-actions[bot]
+          commit_user_name: JellyRock-bot
+          commit_user_email: c.ewert@gmail.com
+          # use JellyRock-bot to author the changes instead of the default author of the merge commit
+          commit_author: JellyRock-bot <c.ewert@gmail.com>