filediff

Create a filediff comment to compare file size changes

Usage

Create a .github/workflows/filediff.yml file.

name: filediff
on:
  pull_request:

jobs:
  filediff:
    name: filediff
    runs-on: ubuntu-latest
    steps:
      - name: Checkout default branch
        uses: actions/checkout@v4

      - name: Create filediff comment
        uses: Shopify/filediff@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          pre_diff_script: npm run build
          target_branch: main
          dir_glob: packages/**/dist/**,images/**

Environment Variables

GITHUB_TOKEN

The GITHUB_TOKEN is needed for changesets to look up the current changeset when creating a snapshot. You can use the automatically created ${{ secrets.GITHUB_TOKEN }} to authenticate in the workflow job.

Action workflow options

target_branch (required)

The branch to compare the directory glob against.

dir_glob (required)

A comma seperated list of globs to compare across branches.

pre_diff_script (optional)

The script to run before generating the filediff comment.

file_details_open (optional, default: false)

Open the file details when the comment is created.

replace_comment (optional, default: true)

Replaces previous filediff comments before creating a new one.

Changelog

v0.0.4

• Only add commas when there are multiple strings in the summary details title
• Eliminated common paths in filename output

v0.0.3

• Fix issue with comparison file path containing PR branch name
• Added option for multiple globs seperated by comma

v0.0.2

• Added option to replace_comment

v0.0.1

• Initial version