next-js-bundle-analysis.yml

name: Next.js Bundle Analysis

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

jobs:
  analyze:
    if: contains(github.head_ref, 'crowdin') == false
    runs-on: ubuntu-latest

    env:
      working-directory: website
    defaults:
      run:
        working-directory: ${{ env.working-directory }}

    steps:
      - name: Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.9.1
        with:
          access_token: ${{ github.token }}

      - name: Check out the repo
        uses: actions/checkout@v4

      - name: Set up env
        uses: the-guild-org/shared-config/setup@main
        with:
          nodeVersion: 20
          packageManager: pnpm

      - name: Restore Next.js Build
        uses: actions/cache@v3
        id: restore-build-cache
        env:
          cache-name: cache-next-build
        with:
          # if you use a custom build directory, replace all instances of `.next` in this file with your build directory
          # ex: if your app builds to `dist`, replace `.next` with `dist`
          path: ${{ env.working-directory }}/.next/cache
          # change this if you prefer a more strict cache
          key: ${{ runner.os }}-build-${{ env.cache-name }}

      - name: Build Next.js App
        # change this if your site requires a custom build command
        run: cd .. && pnpm 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 --package=nextjs-bundle-analysis dlx report

      - name: Upload bundle
        uses: actions/upload-artifact@v3
        with:
          name: bundle
          path: ${{ env.working-directory }}/.next/analyze/__bundle_analysis.json

      - name: Download Base Branch Bundle Stats
        uses: dawidd6/action-download-artifact@v2
        if: success() && github.event.number
        with:
          workflow: next-js-bundle-analysis.yml
          branch: ${{ github.event.pull_request.base.ref }}
          path: ${{ env.working-directory }}/.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 .next/analyze/base && pnpm --package=nextjs-bundle-analysis dlx compare

      - name: Get Comment Body
        id: get-comment-body
        if: success() && github.event.number
        # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
        run: |
          echo "body<<EOF" >> $GITHUB_OUTPUT
          echo "$(cat .next/analyze/__bundle_analysis_comment.txt)" >> $GITHUB_OUTPUT
          echo EOF >> $GITHUB_OUTPUT

      - 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 or Update Comment
        uses: peter-evans/create-or-update-comment@v2.1.1
        if: success() && github.event.number
        with:
          issue-number: ${{ github.event.number }}
          body: ${{ steps.get-comment-body.outputs.body }}
          comment-id: ${{ steps.fc.outputs.comment-id }}
          edit-mode: replace