Bundle size reporter github action

Action for reporting bundle size difference

Inputs

paths - [Required] Paths to bundle size json files. Comma separated list.

onlyDiff - Report only differences. Default "true".

Outputs

summary - string Table of bundle size differences in markdown format.

reports - object All file/bundle reports.

hasDifferences - boolean Did any bundle size change

Usage

  - name: Checkout branch
    uses: actions/checkout@v3
    with:
      ref: 'test' # branch to compare to
      path: br-base # required
      token: ${{ secrets.GITHUB_TOKEN }}

  - name: Bundle size report
    id: bundleSize
    uses: nejcm/[email protected]
    with:
      paths: 'reports/**/*.json'
      onlyDiff: 'true'

Post a comment and action summary

  # post action summary
  - name: Bundle size summary
    if: steps.bundleSize.outputs.hasDifferences == 'true'
    run: |
      echo "${{ steps.bundleSize.outputs.summary }}" >> $GITHUB_STEP_SUMMARY

  # post PR comment
  - uses: marocchino/sticky-pull-request-comment@v2
    if: steps.bundleSize.outputs.hasDifferences == 'true'
    with:
      number: ${{ github.event.pull_request.number }}
      header: 'Bundle size'
      message: ${{ steps.bundleSize.outputs.summary }}
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Example