nextjs-bundle-analysis.yml

name: "Web App Bundle Analysis"

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  workflow_dispatch:

defaults:
  run:
    # change this if your nextjs app does not live at the root of the repo
    working-directory: ./

env:
  CI: true
  NX_DAEMON: false
  NX_VERBOSE_LOGGING: true
  SKIP_ENV_VALIDATION: true
  GITHUB_ACTOR: "🤖 Storm Bot"
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
  analyze:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Setup pnpm
        uses: pnpm/action-setup@v2.2.4
        with:
          version: 8

      - uses: actions/setup-node@v3
        with:
          registry-url: https://registry.npmjs.org/
          node-version-file: .github/.nvmrc
          cache: pnpm
          cache-dependency-path: pnpm-lock.yaml

      - name: Install Dependencies
        run: pnpm ci

      - name: Restore next build
        uses: actions/cache@v3
        id: restore-build-cache
        env:
          cache-name: cache-next-build
        with:
          path: dist/apps/web/shell/.next/cache
          # change this if you prefer a more strict cache
          key: ${{ runner.os }}-build-${{ env.cache-name }}

      - name: Set appropriate base and head commits for `nx affected` commands
        run: |
          echo "BASE: ${{ env.NX_BASE }}"
          echo "HEAD: ${{ env.NX_HEAD }}"

      - name: Prepare for build
        run: pnpm build --base=${{ env.NX_BASE }} --head=${{ env.NX_HEAD }}

      - name: Build next.js app
        env:
          SKIP_BUILD_PRODUCT_REDIRECTS: 1
        run: pnpm nx run web-shell:build

      # Here's the first place where next-bundle-analysis' own script is used
      # This step pulls the raw bundle stats for the current bundle
      - name: Analyze bundle
        run: pnpm -p nextjs-bundle-analysis report

      - name: Upload bundle
        uses: actions/upload-artifact@v3
        with:
          name: bundle
          path: dist/apps/web/shell/.next/analyze/__bundle_analysis.json

      #- name: Download base branch bundle stats
      #  uses: dawidd6/action-download-artifact@v2
      #  if: success() && github.event.number
      #  with:
      #    workflow: nextjs_bundle_analysis.yml
      #    branch: ${{ github.event.pull_request.base.ref }}
      #    path: dist/apps/web/shell/.next/analyze/base

      # And here's the second place - this runs after we have both the current and
      # base branch bundle stats, and will compare them to determine what changed.
      # There are two configurable arguments that come from package.json:
      #
      # - budget: optional, set a budget (bytes) against which size changes are measured
      #           it's set to 350kb here by default, as informed by the following piece:
      #           https://infrequently.org/2021/03/the-performance-inequality-gap/
      #
      # - red-status-percentage: sets the percent size increase where you get a red
      #                          status indicator, defaults to 20%
      #
      # Either of these arguments can be changed or removed by editing the `nextBundleAnalysis`
      # entry in your package.json file.
      #- name: Compare with base branch bundle
      #  if: success() && github.event.number
      #  run: ls -laR dist/apps/web/shell/.next/analyze/base && npx -p nextjs-bundle-analysis compare

      #- name: Get comment body
      #  id: get-comment-body
      #  if: success() && github.event.number
      #  uses: actions/github-script@v6
      #  with:
      #    result-encoding: string
      #    script: |
      #      const fs = require('fs')
      #      const comment = fs.readFileSync('dist/apps/web/shell/.next/analyze/__bundle_analysis_comment.txt', 'utf8')
      #      core.setOutput('body', comment)

      #- name: Find Comment
      #  uses: peter-evans/find-comment@v2
      #  if: success() && github.event.number
      #  id: fc
      #  with:
      #    issue-number: ${{ github.event.number }}
      #    body-includes: "<!-- __NEXTJS_BUNDLE -->"

      #- name: Create Comment
      #  uses: peter-evans/create-or-update-comment@v3
      #  if: success() && github.event.number && steps.fc.outputs.comment-id == 0
      #  with:
      #    issue-number: ${{ github.event.number }}
      #    body: ${{ steps.get-comment-body.outputs.body }}

      #- name: Update Comment
      #  uses: peter-evans/create-or-update-comment@v3
      #  if: success() && github.event.number && steps.fc.outputs.comment-id != 0
      #  with:
      #    issue-number: ${{ github.event.number }}
      #    body: ${{ steps.get-comment-body.outputs.body }}
      #    comment-id: ${{ steps.fc.outputs.comment-id }}
      #    edit-mode: replace