GitHub Action for uploading Storybooks to VizDiff for visual screenshot testing.

Upload Storybook screenshots to VizDiff from any workflow and wire them to commits, branches, or pull-requests. Designed as a lightweight composite action—no Docker, no vendored dependencies—just one npm install under the hood.

(There are no formal outputs.)

# .github/workflows/visual-tests.yml
name: Visual tests

on: [push, pull_request]

jobs:
  vizdiff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Build Storybook
        run: |
          yarn install --immutable
          yarn build-storybook

      - name: Upload screenshots to VizDiff
        uses: vizdiff-io/upload-action@v1
        with:
          project-token: ${{ secrets.VIZDIFF_PROJECT_TOKEN }}
          storybook-dir: "./frontend/storybook-static" # optional override

The action installs the latest @vizdiff/cli from npm 📦.

Environment variables for commit, branch, base branch/commit, and PR number are derived automatically (works for both push and pull_request events).

It runs

vizdiff upload --commit $COMMIT_SHA --branch $BRANCH_NAME \
  --base-branch $BASE_BRANCH --base-commit $BASE_COMMIT \
  --pr $PR_NUMBER ./storybook-static

Patch releases → tag v1.0.1, feature releases → tag v1.1.0, force-move lightweight tag v1 to point to it. Users pinned to @v1 get the update automatically.

Breaking change → bump to v2.0.0 and create/update v2.

Draft a GitHub Release so the release notes show on the Marketplace listing.

MIT (see LICENSE).