From 96713f52231160dd4ad032bc0e94daa32f40bf19 Mon Sep 17 00:00:00 2001 From: ajnart Date: Mon, 15 May 2023 17:23:11 +0900 Subject: [PATCH 1/7] =?UTF-8?q?=F0=9F=91=B7=20Add=20NextJS=20bundle=20anal?= =?UTF-8?q?ysis=20GitHub=20Action?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/docker_dev.yml | 17 +-- .github/workflows/nextjs_bundle_analysis.yml | 129 +++++++++++++++++++ package.json | 10 +- 3 files changed, 144 insertions(+), 12 deletions(-) create mode 100644 .github/workflows/nextjs_bundle_analysis.yml diff --git a/.github/workflows/docker_dev.yml b/.github/workflows/docker_dev.yml index d65cbea87..f114e2ea5 100644 --- a/.github/workflows/docker_dev.yml +++ b/.github/workflows/docker_dev.yml @@ -56,17 +56,14 @@ jobs: restore-keys: | ${{ runner.os }}-yarn- - - name: Restore NextJS cache - uses: actions/cache@v2 + - name: Restore next build + uses: actions/cache@v3 + id: restore-build-cache + env: + cache-name: cache-next-build with: - # See here for caching with `yarn` https://github.com/actions/cache/blob/main/examples.md#node---yarn or you can leverage caching with actions/setup-node https://github.com/actions/setup-node - path: | - ${{ github.workspace }}/.next/cache - # Generate a new cache whenever packages or source files change. - key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }} - # If source files changed but packages didn't, rebuild from a prior cache. - restore-keys: | - ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}- + path: .next/cache + key: ${{ runner.os }}-build-${{ env.cache-name }} - run: yarn install --immutable diff --git a/.github/workflows/nextjs_bundle_analysis.yml b/.github/workflows/nextjs_bundle_analysis.yml new file mode 100644 index 000000000..fd976da39 --- /dev/null +++ b/.github/workflows/nextjs_bundle_analysis.yml @@ -0,0 +1,129 @@ +# 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 }} + + - name: Build next.js app + # change this if your site requires a custom build command + run: ./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: 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 + 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: Find Comment + uses: peter-evans/find-comment@v2 + if: success() && github.event.number + id: fc + with: + issue-number: ${{ github.event.number }} + body-includes: '' + + - name: Create Comment + uses: peter-evans/create-or-update-comment@v2 + 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@v2 + 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 diff --git a/package.json b/package.json index a4a519d0f..a0ee4d67f 100644 --- a/package.json +++ b/package.json @@ -114,5 +114,11 @@ "@types/react": "17.0.2", "@types/react-dom": "17.0.2" }, - "packageManager": "yarn@3.2.1" -} + "packageManager": "yarn@3.2.1", + "nextBundleAnalysis": { + "budget": null, + "budgetPercentIncreaseRed": 20, + "minimumChangeThreshold": 0, + "showDetails": true + } +} \ No newline at end of file From 141004c39f6ea256b93305f8e3c822f538e2f2ec Mon Sep 17 00:00:00 2001 From: ajnart Date: Mon, 15 May 2023 17:24:46 +0900 Subject: [PATCH 2/7] =?UTF-8?q?=F0=9F=92=9A=20Change=20to=20using=20turbo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/nextjs_bundle_analysis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/nextjs_bundle_analysis.yml b/.github/workflows/nextjs_bundle_analysis.yml index fd976da39..b24fb6076 100644 --- a/.github/workflows/nextjs_bundle_analysis.yml +++ b/.github/workflows/nextjs_bundle_analysis.yml @@ -57,7 +57,7 @@ jobs: - name: Build next.js app # change this if your site requires a custom build command - run: ./node_modules/.bin/next build + 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 From b35bbedb77eddd66824137ba16462bf84d8199f7 Mon Sep 17 00:00:00 2001 From: ajnart Date: Mon, 15 May 2023 17:27:52 +0900 Subject: [PATCH 3/7] =?UTF-8?q?=F0=9F=92=9A=20Add=20yarn=20install=20to=20?= =?UTF-8?q?CI=20for=20bundle=20analysis?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/nextjs_bundle_analysis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/nextjs_bundle_analysis.yml b/.github/workflows/nextjs_bundle_analysis.yml index b24fb6076..a2ac54930 100644 --- a/.github/workflows/nextjs_bundle_analysis.yml +++ b/.github/workflows/nextjs_bundle_analysis.yml @@ -55,6 +55,8 @@ jobs: # 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 From dc7e860263f99ceaca84e9b705933026f65d974d Mon Sep 17 00:00:00 2001 From: ajnart Date: Mon, 15 May 2023 17:37:00 +0900 Subject: [PATCH 4/7] =?UTF-8?q?=F0=9F=94=A7=20Add=20base=20config=20for=20?= =?UTF-8?q?anaylyze?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .next/analyze/base/client.html | 38 ++++++++++++++++++++++++++++++++++ .next/analyze/base/server.html | 38 ++++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 .next/analyze/base/client.html create mode 100644 .next/analyze/base/server.html diff --git a/.next/analyze/base/client.html b/.next/analyze/base/client.html new file mode 100644 index 000000000..20394ef75 --- /dev/null +++ b/.next/analyze/base/client.html @@ -0,0 +1,38 @@ + + + + + + homarr [15 May 2023 at 17:36] + + + + + + + + +
+ + + \ No newline at end of file diff --git a/.next/analyze/base/server.html b/.next/analyze/base/server.html new file mode 100644 index 000000000..54891ac1c --- /dev/null +++ b/.next/analyze/base/server.html @@ -0,0 +1,38 @@ + + + + + + homarr [15 May 2023 at 17:36] + + + + + + + + +
+ + + \ No newline at end of file From bea4e8616780e3893fe039ba288bb9a89ec6ecd2 Mon Sep 17 00:00:00 2001 From: ajnart Date: Mon, 15 May 2023 17:45:20 +0900 Subject: [PATCH 5/7] =?UTF-8?q?=F0=9F=92=9A=20Continue=20on=20error=20and?= =?UTF-8?q?=20update=20comment=20feature?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/nextjs_bundle_analysis.yml | 29 ++++---------------- 1 file changed, 6 insertions(+), 23 deletions(-) diff --git a/.github/workflows/nextjs_bundle_analysis.yml b/.github/workflows/nextjs_bundle_analysis.yml index a2ac54930..70271a550 100644 --- a/.github/workflows/nextjs_bundle_analysis.yml +++ b/.github/workflows/nextjs_bundle_analysis.yml @@ -74,6 +74,7 @@ jobs: - 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 @@ -106,26 +107,8 @@ jobs: 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: '' - - - name: Create Comment - uses: peter-evans/create-or-update-comment@v2 - 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@v2 - 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 + - name: Comment + uses: marocchino/sticky-pull-request-comment@v2 + with: + header: next-touched-pages + message: ${{ steps.get-comment-body.outputs.body }} \ No newline at end of file From 29d0b63f400a7a3d9878826db1e43b88b7e9f53f Mon Sep 17 00:00:00 2001 From: ajnart Date: Mon, 15 May 2023 18:10:44 +0900 Subject: [PATCH 6/7] =?UTF-8?q?=E2=9A=B0=EF=B8=8F=20Remove=20`continue-on-?= =?UTF-8?q?error`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/nextjs_bundle_analysis.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/nextjs_bundle_analysis.yml b/.github/workflows/nextjs_bundle_analysis.yml index 70271a550..c45c75eb5 100644 --- a/.github/workflows/nextjs_bundle_analysis.yml +++ b/.github/workflows/nextjs_bundle_analysis.yml @@ -74,7 +74,6 @@ jobs: - 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 From 7f49ca7983d8508c2fef98a9059087e4eed86069 Mon Sep 17 00:00:00 2001 From: ajnart Date: Mon, 15 May 2023 18:12:30 +0900 Subject: [PATCH 7/7] =?UTF-8?q?=F0=9F=92=9A=20Continue=20on=20error=20and?= =?UTF-8?q?=20update=20comment=20feature?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/nextjs_bundle_analysis.yml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/workflows/nextjs_bundle_analysis.yml b/.github/workflows/nextjs_bundle_analysis.yml index c45c75eb5..9f04bd67c 100644 --- a/.github/workflows/nextjs_bundle_analysis.yml +++ b/.github/workflows/nextjs_bundle_analysis.yml @@ -74,6 +74,7 @@ jobs: - 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 @@ -106,8 +107,8 @@ jobs: 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 }} \ No newline at end of file + - name: Comment + uses: marocchino/sticky-pull-request-comment@v2 + with: + header: next-touched-pages + message: ${{ steps.get-comment-body.outputs.body }} \ No newline at end of file