This action compares two Vite compilation stats files and comments on the PR with a description of the difference.
Install vite-bundle-analyzer:
npm install vite-bundle-analyzer --save-devor:
yarn add vite-bundle-analyzer --devIn vite.config.ts, configure vite-bundle-analyzer to output JSON:
import { defineConfig } from 'vite'; import { analyzer } from 'vite-bundle-analyzer'; export default defineConfig({ vite: { plugins: [ analyzer({ analyzerMode: 'json', }), ], }, });Tip
You could enable this plugin conditionally in GitHub Actions by checking for process.env.ANALYZE environment variable.
In your action configuration, build both the head and the branch (in any way you see fit) and pass paths to the stats.json files as inputs on this action:
name: Compare bundle size on: pull_request: branches: [main] jobs: build-head: name: Build head runs-on: ubuntu-latest permissions: contents: read steps: - name: Checkout uses: actions/checkout@v4 with: ref: ${{github.event.pull_request.head.ref}} - name: Install dependencies run: npm ci - name: Build run: npm run build - name: Upload stats.json uses: actions/upload-artifact@v4 with: name: head-stats path: ./dist/stats.json build-base: name: Build base runs-on: ubuntu-latest permissions: contents: read steps: - name: Checkout uses: actions/checkout@v4 with: ref: ${{ github.base_ref }} - name: Install dependencies run: npm ci - name: Build run: npm run build - name: Upload stats.json uses: actions/upload-artifact@v4 with: name: base-stats path: ./dist/stats.json compare: name: Compare bundle size runs-on: ubuntu-latest needs: [build-base, build-head] permissions: pull-requests: write steps: - name: Download stats.json files uses: actions/download-artifact@v4 - name: Compare bundle size uses: wojtekmaj/vite-compare-bundle-size@v1 with: github-token: ${{ secrets.GITHUB_TOKEN }} current-stats-json-path: ./head-stats/stats.json base-stats-json-path: ./base-stats/stats.jsonThis action requires the write permission for the permissions.pull-requests scope.
| name | description | required | type |
|---|---|---|---|
| current-stats-json-path | The path to the current stats.json file | true | string |
| base-stats-json-path | The path to the base stats.json file | true | string |
| github-token | The GitHub token to use for authentication | true | string |
| title | An optional addition to the title, which also helps key comments, useful if running more than 1 copy of this action | false | string |
| describe-assets | Option for asset description output. One of "all" (default), "changed-only", or "none". | false | string |
The MIT License.
 | Wojciech Maj |