2dc88197bc
Bumps [actions/checkout](https://github.com/actions/checkout) from 6 to 7. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v6...v7) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
103 lines
3.5 KiB
YAML
103 lines
3.5 KiB
YAML
name: Update visual snapshots
|
|
|
|
# How to use this workflow
|
|
# ========================
|
|
#
|
|
# Visual snapshots live in `apps/planner/app/**/__screenshots__/` and are
|
|
# committed to the repo. They are generated by Vitest browser mode running
|
|
# the Planner's `*.browser.test.tsx` files against real Chromium via Playwright.
|
|
#
|
|
# When to update snapshots:
|
|
# - You intentionally changed the look of the elevation chart (new color mode,
|
|
# layout change, etc.) and the old snapshots are now wrong.
|
|
# - You added a new `*.browser.test.tsx` test and need the initial snapshots.
|
|
#
|
|
# Two ways to trigger this workflow:
|
|
#
|
|
# 1. Manual dispatch (workflow_dispatch):
|
|
# Go to Actions → "Update visual snapshots" → "Run workflow".
|
|
# Choose the branch you want updated. The workflow will commit the new
|
|
# snapshots back to that branch.
|
|
#
|
|
# 2. PR label (update-snapshots):
|
|
# Add the `update-snapshots` label to any PR. The workflow will update
|
|
# snapshots on the PR's head branch. Remove the label after to avoid
|
|
# re-triggering on every subsequent push.
|
|
#
|
|
# After the workflow commits updated snapshots, pull the branch locally:
|
|
# git pull origin <your-branch>
|
|
#
|
|
# Running locally:
|
|
# pnpm --filter @trails-cool/planner test:visual # run tests
|
|
# pnpm --filter @trails-cool/planner test:visual:update # update snapshots
|
|
#
|
|
# Platform note:
|
|
# Snapshots are generated on ubuntu-latest to keep CI and local results
|
|
# consistent. Snapshots generated on macOS or Windows will have subtle
|
|
# font-rendering differences and will fail on CI. Always use this workflow
|
|
# (or a Linux machine / Docker) to produce the canonical snapshots.
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
branch:
|
|
description: "Branch to update snapshots on"
|
|
required: false
|
|
default: ""
|
|
|
|
pull_request:
|
|
types: [labeled]
|
|
|
|
jobs:
|
|
update-snapshots:
|
|
# Only run for manual dispatch, or when the label is "update-snapshots"
|
|
if: >
|
|
github.event_name == 'workflow_dispatch' ||
|
|
(github.event_name == 'pull_request' && github.event.label.name == 'update-snapshots')
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
permissions:
|
|
contents: write # needed to push snapshot commits back
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v7
|
|
with:
|
|
ref: ${{ github.event.pull_request.head.ref || github.event.inputs.branch || github.ref }}
|
|
# Use a token with push rights so the commit-back step can push
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Setup pnpm
|
|
uses: pnpm/action-setup@v6
|
|
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 24
|
|
cache: "pnpm"
|
|
|
|
- name: Install dependencies
|
|
run: pnpm install --frozen-lockfile
|
|
|
|
- name: Install Playwright Chromium
|
|
run: pnpm exec playwright install chromium --with-deps
|
|
|
|
- name: Update visual snapshots
|
|
run: pnpm --filter @trails-cool/planner test:visual:update
|
|
|
|
- name: Commit updated snapshots
|
|
uses: stefanzweifel/git-auto-commit-action@v7
|
|
with:
|
|
commit_message: "chore: update visual snapshots [skip ci]"
|
|
file_pattern: "apps/planner/app/**/__screenshots__/**"
|
|
commit_user_name: "github-actions[bot]"
|
|
commit_user_email: "github-actions[bot]@users.noreply.github.com"
|
|
|
|
- name: Upload snapshots as artifact
|
|
if: always()
|
|
uses: actions/upload-artifact@v7
|
|
with:
|
|
name: visual-snapshots
|
|
path: apps/planner/app/**/__screenshots__/
|
|
if-no-files-found: ignore
|