fix: Add build to typedoc step (#105)

Actually build the docs, and fix the deployment process.

Author: nsdeschenes

.eslintrc.js

@@ -16,7 +16,7 @@ const config = {
     "**/test-apps/**",
     "**/integration-tests/**/*.cjs",
     "**/integration-tests/test-api/**/*",
-    "**/scripts/publish-docs.js",
+    "**/scripts/publish-docs.mjs",
     "**/typedoc/plugin-remove-references.js",
   ],
   parserOptions: {

.github/workflows/typedoc_manual_deploy.yml

@@ -5,12 +5,29 @@ on:
 
 jobs:
   deploy_docs:
+    permissions:
+      contents: 'write'
     name: Deploy TypeDocs
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
 
+      - name: Import GPG key
+        id: import-gpg
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.RELEASER_GPG_PRIVATE_KEY }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+          git_config_global: true
+
+      - name: Setup Git
+        run: |
+          echo "machine github.com login x password ${{ secrets.GITHUB_TOKEN }}" > ~/.netrc
+          git config --global url."https://github.com/".insteadOf "git://github.com/"
+          git config --global advice.detachedHead false
+
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
@@ -23,4 +40,7 @@ jobs:
           run_install: true
 
       - name: Publish new docs
-        run: node scripts/publish-docs.js
+        run: node scripts/publish-docs.mjs
+        env:
+          GIT_USERNAME: ${{ steps.import-gpg.outputs.name }}
+          GIT_EMAIL: ${{ steps.import-gpg.outputs.email }}

scripts/publish-docs.js renamed to scripts/publish-docs.mjs

@@ -2,6 +2,7 @@ import { execSync } from "child_process";
 
 function buildDocs() {
   execSync("rm -rf ./typedoc/docs");
+  execSync("pnpm run build");
   execSync("pnpm run generate:typedoc");
 }
 
@@ -10,9 +11,11 @@ function publishDocs() {
 	mkdir /tmp/js-docs
 	cp -r ./typedoc/docs /tmp/js-docs/docs
 	cd /tmp/js-docs && \
-	git clone --single-branch --branch gh-pages git@github.com:codecov/codecov-javascript-bundler-plugins.git && \
+	git clone --single-branch --branch gh-pages https://github.com/codecov/codecov-javascript-bundler-plugins.git && \
 	cp -r /tmp/js-docs/docs/* /tmp/js-docs/codecov-javascript-bundler-plugins/ && \
 	cd /tmp/js-docs/codecov-javascript-bundler-plugins && \
+	git config --global user.name "codecov-releaser" && \
+	git config --global user.email "[email protected]" && \
 	git add --all && \
 	git commit -m "meta: Update docs" && \
 	git push origin gh-pages`);

typedoc.json

@@ -1,11 +1,11 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "readme": "README.md",
-  "name": "Codecov JavaScript Bundler PLugins",
+  "name": "Codecov JavaScript Bundler Plugins",
   "entryPoints": ["packages/*"],
   "entryPointStrategy": "packages",
   "out": "./typedoc/docs",
-  "includeVersion": true,
+  "includeVersion": false,
   "excludePrivate": true,
   "excludeExternals": true,
   "excludeReferences": true,