chore: Clean up API docs infra (#2222)

Author: dcodeIO

.github/workflows/release.yaml

@@ -22,6 +22,8 @@ jobs:
 
       - uses: actions/checkout@v6
         if: ${{ steps.release.outputs.releases_created == 'true' }}
+        with:
+          submodules: true
 
       - uses: actions/setup-node@v6
         if: ${{ steps.release.outputs.releases_created == 'true' }}
@@ -57,3 +59,10 @@ jobs:
         if: ${{ steps.release.outputs['cli--release_created'] == 'true' }}
         working-directory: cli
         run: npm publish --ignore-scripts
+
+      - name: Publish API docs
+        if: ${{ steps.release.outputs.release_created == 'true' }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          npm run docs:publish

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/jsdoc-template"]
+	path = lib/jsdoc-template
+	url = https://github.com/protobufjs/jsdoc-template.git

config/jsdoc.json

@@ -20,7 +20,7 @@
             "outputSourceFiles" : false
         },
         "applicationName": "protobuf.js",
-        "googleAnalytics": "UA-40277577-3",
+        "applicationSubtitle": "API documentation",
         "linenums"      : true
     },
     "markdown"  : {
@@ -34,8 +34,9 @@
         "private"       : false,
         "lenient"       : false,
         "destination"   : "./docs",
-        "template"      : "./node_modules/jaguarjs-jsdoc",
-        "sourceRoot"    : "https://github.com/dcodeIO/protobuf.js/blob/master/src/",
-        "repo"          : "https://github.com/dcodeIO/protobuf.js"
+        "template"      : "./lib/jsdoc-template",
+        "sourceRoot"    : "https://github.com/protobufjs/protobuf.js/blob/master/src/",
+        "repo"          : "https://github.com/protobufjs/protobuf.js",
+        "repoBranch"    : "master"
     }
-}
+}

eslint.config.cjs

@@ -15,6 +15,7 @@ module.exports = [
             "docs/**",
             "examples/**",
             "lib/deep-equal/**",
+            "lib/jsdoc-template/**",
             "lib/prelude.js",
             "lib/polyfill.js",
             "lib/tape-adapter.js",

lib/jsdoc-template

@@ -26,11 +26,12 @@
     "coverage": "npm run coverage:test && npm run coverage:report",
     "coverage:test": "nyc --silent tape -r ./lib/tape-adapter tests/*.js tests/node/*.js",
     "coverage:report": "nyc report --reporter=lcov --reporter=text",
-    "docs": "jsdoc -c config/jsdoc.json -R README.md --verbose --pedantic",
+    "docs": "npm run docs:build",
+    "docs:build": "jsdoc -c config/jsdoc.json -R README.md --verbose --pedantic",
+    "docs:publish": "npm run docs:build && node scripts/pages",
     "lint": "npm run lint:sources && npm run lint:types",
     "lint:sources": "eslint \"**/*.js\"",
     "lint:types": "tslint \"**/*.d.ts\" -e \"**/node_modules/**\" -t stylish -c config/tslint.json",
-    "pages": "node scripts/pages",
     "prepublish": "cd cli && npm install && cd .. && npm run build",
     "prepublishOnly": "cd cli && npm install && cd .. && npm run build",
     "postinstall": "node scripts/postinstall",
@@ -64,7 +65,6 @@
     "gulp-if": "^3.0.0",
     "gulp-sourcemaps": "^3.0.0",
     "gulp-uglify": "^3.0.2",
-    "jaguarjs-jsdoc": "github:dcodeIO/jaguarjs-jsdoc",
     "jsdoc": "^4.0.0",
     "minimist": "^1.2.0",
     "nyc": "^18.0.0",