Update Screenshots

microsoft/vscode/.github/skills/update-screenshots

作者 microsoft001f205a1f401a09dd530b1ac1a54424a2225d0d无许可证193K 个星标收录于 2026年10月9日更新于 2026年10月9日仓库今天更新

Update the committed blocks-ci screenshot hashes after the "Screenshots & Tests" check fails, or investigate a screenshot diff reported on a PR. Use when asked to update, accept, or refresh component screenshot baselines from CI. This skill should be run as a subagent.

AI 生成的概览

在 Screenshots & Tests 检查失败后,更新已提交的 CI 截图哈希基线。

功能
该技能指导代理在 Screenshots & Tests CI 任务报告哈希不匹配时,刷新已提交的 blocks-ci 截图哈希文件。内容包括从 CI 任务界面获取预期哈希、通过下载并比对新旧图片确认视觉差异是有意为之,以及仅修改已提交 Markdown 文件中发生变化的行后再提交。它还说明如何利用上传的截图产物进一步排查,以及如何区分哈希不匹配与真正的渲染或测试失败。
适用场景
当 Screenshots & Tests 检查因 blocks-ci 哈希不匹配而失败,或被要求从 CI 更新、接受、刷新组件截图基线时使用。也适用于排查拉取请求上报告的截图差异。
运行要求
需要已通过身份验证的 GitHub CLI(gh)、对外部截图服务的网络访问,以及带 Pillow 的 Python 3 用于图片比对。该技能不附带脚本,全部为操作说明。

Update Component Screenshots from CI

Screenshot images are not stored in the repository — they live in an external service (hediet-screenshots.azurewebsites.net), keyed by commit SHA. But a subset of fixtures is pinned by hash in test/componentFixtures/blocks-ci-screenshots.md, and that file is committed. When those hashes change, CI fails and you must update the file.

Two different outcomes, only one of which blocks

The Screenshots & Tests job in .github/workflows/component-fixtures.yml produces two independent results:

ResultBlocking?Action
Screenshot diff report (PR comment with before/after images)No — informationalReview the visuals. Nothing to commit.
blocks-ci hash mismatchYes — fails the checkUpdate blocks-ci-screenshots.md and commit.

A fixture opts into the blocking gate with labels: { kind: 'screenshot', blocksCi: true }. Only those fixtures appear in blocks-ci-screenshots.md.

The failure looks like this:

##[error]blocks-ci screenshot hashes do not match committed file. See PR comment or job summary for the updated content.

Step 1: Get the expected hashes from CI

Never regenerate the hashes locally. They are hashes of the rendered PNG bytes, produced on ubuntu-latest. Rendering on macOS or Windows yields different bytes and therefore different hashes, so locally generated values will fail CI. Always copy the values from the CI job.

Three surfaces carry the same content — use whichever is handy:

  • The PR comment titled "blocks-ci screenshots changed" (non-fork PRs only) — contains the full updated file plus a patch.
  • The job summary, which gets the identical body and is the only surface fork PRs receive.
  • The job log, whose final step prints a unified diff:
bash
gh api repos/microsoft/vscode/actions/jobs/<JOB_ID>/logs > "$TMPDIR/ci-job-log.txt"grep -n '##\[error\]' "$TMPDIR/ci-job-log.txt"

Find the failed job id with:

bash
gh pr checks <PR> --json name,link,bucket --jq '.[] | select(.name == "Screenshots & Tests")'

Step 2: Verify the change is intentional before accepting it

This gate exists to catch unintended layout regressions, so accepting new hashes without looking at the images defeats its purpose. The images are publicly fetchable by hash, so pull both the old (committed) and new (from CI) versions and compare:

bash
curl -sL -o old.png "https://hediet-screenshots.azurewebsites.net/images/<OLD_HASH>"curl -sL -o new.png "https://hediet-screenshots.azurewebsites.net/images/<NEW_HASH>"

Then view them, and localize the change rather than eyeballing full screenshots — the delta is often only a pixel or two:

bash
python3 -c "from PIL import Image, ImageChopsa = Image.open('old.png').convert('RGB'); b = Image.open('new.png').convert('RGB')print('diff bbox:', ImageChops.difference(a, b).getbbox())"

Confirm the delta matches what the PR intends. If the fixture is unrelated to the change, or the shift is larger than expected, treat it as a regression and fix the code instead of the hashes.

Step 3: Apply and commit

Edit only the changed lines in test/componentFixtures/blocks-ci-screenshots.md, replacing the old hash in the image URL with the new one:

md
#### editor/inlineChatZoneWidget/InlineChatZoneWidget/Dark![screenshot](https://hediet-screenshots.azurewebsites.net/images/<NEW_HASH>)

The file is generated by build/lib/screenshotBlocksCi.ts and compared byte-for-byte, so keep the <!-- auto-generated by CI — do not edit manually --> header, the #### <fixtureId> / image-link pairing, the blank line between entries, and the fixtureId sort order intact. Verify your edit is the exact inverse of the diff CI reported:

bash
git diff test/componentFixtures/blocks-ci-screenshots.md

Then commit and push. The check re-runs and should pass; hashes on main become the new baseline after merge.

Investigating further

Raw captured images and the manifest for a run are uploaded as an artifact:

bash
gh run download <RUN_ID> --name screenshots --dir .tmp/screenshots

manifest.json maps each fixtureId to its imageHash and any render errors.

Related failures from the same job

The check also fails if a fixture failed to render (Fail if fixtures had errors) or if the Playwright fixture tests failed. Those are genuine bugs — updating hashes will not help. Look for ::error::<fixtureId>: in the log, and download the playwright-test-results artifact for test failures.

来源与署名

来源:microsoft/vscode位于.github/skills/update-screenshots提交001f205

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架