Skip to content

ci(ios): refresh the doc site example screenshots through a maps-docs PR - #4382

Merged
mfazekas merged 1 commit into
mainfrom
ci/nightly-doc-screenshots-pr
Oct 22, 2026
Merged

mfazekas merged 1 commit into
mainfrom
ci/nightly-doc-screenshots-pr

Conversation

@mfazekas

Copy link
Copy Markdown
Contributor

Description

The nightly doc screenshot run now refreshes the doc site's example screenshots through a reviewable maps-docs PR instead of them going stale. A new job compares the captured screenshots with maps-docs main and copies only those that changed by more than 0.5% of the pixels (status bar ignored), plus new examples; screenshots of removed examples are dropped and screenshots.json is kept in sync. Unchanged images stay byte-identical. If anything changed it force-pushes a single commit on top of maps-docs main to auto/example-screenshots with the existing deploy key; rnmapbox/maps-docs#16 opens/updates the PR from that branch.

excludeFromPercy examples differ by 2-80% between runs (measured on three recent captures), so no threshold separates real changes from noise; they are only replaced when new, when the screenshot size changes, or when the workflow is dispatched with refresh_unstable.

Tested with a temporary push trigger that reused the doc-screenshots artifact of run 39746036267: the job pushed the branch with the deploy key, the maps-docs workflow opened a PR, a rerun detected the branch was up to date, and a further push updated the PR body. Test branches and PR are deleted.

Checklist

  • I've read CONTRIBUTING.md
  • I updated the doc/other generated code with running yarn generate in the root folder
  • I have tested the new feature on /example app.
  • I added/updated a sample - if a new feature was implemented (/example)

@mfazekas
mfazekas merged commit bcc3452 into main Oct 22, 2026
10 checks passed
@mfazekas
mfazekas deleted the ci/nightly-doc-screenshots-pr branch October 22, 2026 14:29

This branch was successfully deployed

1 active deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant