build: Fix publish CI for publishing docs (#108)

Update publish step to auto-deploy new TypeDoc docs.

Author: nsdeschenes

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -64,7 +64,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -110,7 +110,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -156,7 +156,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -272,8 +272,8 @@ jobs:
       - name: Run e2e tests
         run: pnpm run test:e2e
 
-  upload-example-build-stats-production:
-    name: Build and upload ${{ matrix.example }} example stats data to production
+  upload-example-stats-production:
+    name: "Production: upload ${{ matrix.example }} stats"
     runs-on: ubuntu-latest
     needs: [install, unit-test, integration-test]
     strategy:
@@ -289,7 +289,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -335,8 +335,8 @@ jobs:
           WEBPACK_API_URL: ${{ secrets.CODECOV_API_URL }}
         run: pnpm run build
 
-  upload-example-build-stats-staging:
-    name: Build and upload ${{ matrix.example }} example stats data to staging
+  upload-example-stats-staging:
+    name: "Staging: upload ${{ matrix.example }} stats"
     runs-on: ubuntu-latest
     needs: [install, unit-test, integration-test]
     strategy:
@@ -352,7 +352,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -399,7 +399,7 @@ jobs:
         run: pnpm run build
 
   upldate-plugin-stats-production:
-    name: Build and upload ${{ matrix.package }} stats data to production
+    name: "Production: upload ${{ matrix.package }} stats"
     runs-on: ubuntu-latest
     needs: [install, unit-test, integration-test]
     strategy:
@@ -421,7 +421,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -461,9 +461,8 @@ jobs:
           PLUGIN_CODECOV_API_URL: ${{ secrets.CODECOV_API_URL }}
         run: pnpm run build
 
-
   upldate-plugin-stats-staging:
-    name: Build and upload ${{ matrix.package }} stats data to staging
+    name: "Staging: upload ${{ matrix.package }} stats"
     runs-on: ubuntu-latest
     needs: [install, unit-test, integration-test]
     strategy:
@@ -485,7 +484,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -511,10 +510,10 @@ jobs:
 
       - name: Install dependencies
         run: pnpm install
-        
+
       - name: Build plugins
         run: pnpm run build
-        
+
       - name: Install plugins
         run: pnpm install
 

.github/workflows/publish.yml

@@ -27,11 +27,30 @@ jobs:
         with:
           node-version-file: "package.json"
 
-      - name: Setup pnpm & install dependencies
+      - name: Setup pnpm
         uses: pnpm/action-setup@v2
         with:
           version: 8
-          run_install: true
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Cache node_modules
+        id: cache-node-modules
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-codecov-js-bundle-plugin-node-modules
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+
+      - name: Install dependencies
+        run: pnpm install
 
       - name: Publish to NPM
         uses: changesets/action@v1
@@ -42,5 +61,63 @@ jobs:
           publish: pnpm changeset:publish
           createGithubReleases: true
 
+  publish_docs:
+    name: Publish Docs
+    needs: publish
+    runs-on: ubuntu-latest
+    # For whatever reason, yaml does not like the full "meta(changelog): Update package versions" string
+    # So we check this in two parts
+    if: |
+      contains(github.event.head_commit.message, 'meta(changelog)') 
+      && contains(github.event.head_commit.message, 'Update package versions')
+    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:
+          node-version-file: "package.json"
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Cache node_modules
+        id: cache-node-modules
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-codecov-js-bundle-plugin-node-modules
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+
+      - name: Install dependencies
+        run: pnpm install
+
       - name: Publish new docs
         run: node scripts/publish-docs.js

.github/workflows/test-api-ci.yml

@@ -16,6 +16,6 @@ jobs:
     uses: codecov/gha-workflows/.github/workflows/[email protected]
     secrets: inherit
     with:
-        push: false
-        image_name: codecov-javascript-bundler-plugins-test-api
-        docker_path: integration-tests/test-api
+      push: false
+      image_name: codecov-javascript-bundler-plugins-test-api
+      docker_path: integration-tests/test-api

.github/workflows/typedoc_manual_deploy.yml renamed to .github/workflows/typedoc-manual-deploy.yml

@@ -5,12 +5,6 @@ ai_pr_review:
   enabled: true
 
 component_management:
-  default_rules:
-    statuses:
-      - type: patch
-        target: auto
-        branches:
-          - "!main"
   individual_components:
     - component_id: package_core
       name: Plugin core