# Copyright (c) HashiCorp, Inc. # SPDX-License-Identifier: MPL-2.0 name: 'Next.js Bundle Analysis' on: pull_request: push: branches: - main # change this if your default branch is named differently workflow_dispatch: defaults: run: # change this if your nextjs app does not live at the root of the repo working-directory: ./ permissions: contents: read # for checkout repository actions: read # for fetching base branch bundle stats pull-requests: write # for comments jobs: analyze: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Install Node.js uses: actions/setup-node@v3 with: node-version: 18 - name: Get yarn cache directory path id: yarn-cache-dir-path run: echo "::set-output name=dir::$(yarn config get cacheFolder)" - uses: actions/cache@v3 id: yarn-cache with: path: ${{ steps.yarn-cache-dir-path.outputs.dir }} key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} restore-keys: | ${{ runner.os }}-yarn- - name: Restore next 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: .next/cache # change this if you prefer a more strict cache key: ${{ runner.os }}-build-${{ env.cache-name }} - run: yarn install - name: Build next.js app # change this if your site requires a custom build command run: yarn turbo 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: npx -p nextjs-bundle-analysis report - name: Upload bundle uses: actions/upload-artifact@v3 with: name: bundle path: .next/analyze/__bundle_analysis.json - name: Download base branch bundle stats uses: dawidd6/action-download-artifact@v2 continue-on-error: true if: success() && github.event.number with: workflow: nextjs_bundle_analysis.yml branch: ${{ github.event.pull_request.base.ref }} path: .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 && npx -p nextjs-bundle-analysis 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<> $GITHUB_OUTPUT echo "$(cat .next/analyze/__bundle_analysis_comment.txt)" >> $GITHUB_OUTPUT echo EOF >> $GITHUB_OUTPUT - name: Comment uses: marocchino/sticky-pull-request-comment@v2 with: header: next-touched-pages message: ${{ steps.get-comment-body.outputs.body }}