Skip to content

Commit

Permalink
chore(ci): add frontend bundle analysis
Browse files Browse the repository at this point in the history
  • Loading branch information
AprilNEA committed Dec 8, 2023
1 parent 1b7601a commit 41eecd8
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 1 deletion.
121 changes: 121 additions & 0 deletions .github/workflows/frontend-bundle-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
name: Frontend Bundle Analysis

on:
pull_request:
push:
branches: [v3]
workflow_dispatch:

defaults:
run:
working-directory: ./

jobs:
analyze:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}

- uses: actions/checkout@v4

- uses: pnpm/[email protected]

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 18
cache: 'pnpm'

- name: Install Dependencies
run: pnpm i

- 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: packages/frontend/.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 packages/frontend && ./node_modules/.bin/next 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: cd packages/frontend && npx -p nextjs-bundle-analysis report

- name: Upload bundle
uses: actions/upload-artifact@v3
with:
name: bundle
path: packages/frontend/.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: packages/frontend/.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 packages/frontend/.next/analyze/base && cd packages/frontend
&& npx -p nextjs-bundle-analysis compare

- name: Get Comment Body
id: get-comment-body
if: success() && github.event.number
run: |
body=$(cat packages/frontend/.next/analyze/__bundle_analysis_comment.txt)
body="${body//'%'/'%25'}"
body="${body//$'\n'/'%0A'}"
body="${body//$'\r'/'%0D'}"
echo ::set-output name=body::$body
- 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/[email protected]
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/[email protected]
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
8 changes: 7 additions & 1 deletion packages/frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
"start": "next start",
"lint": "next lint"
},
"nextBundleAnalysis": {
"budget": null,
"budgetPercentIncreaseRed": 20,
"minimumChangeThreshold": 0,
"showDetails": true
},
"dependencies": {
"@radix-ui/colors": "^3.0.0",
"@radix-ui/react-icons": "^1.3.0",
Expand Down Expand Up @@ -44,4 +50,4 @@
"typescript": "*"
},
"packageManager": "[email protected]"
}
}

0 comments on commit 41eecd8

Please sign in to comment.