mrchazaaa/Update README Screenshot

Capture a site as a PNG screenshot or animated GIF, write it to a repo-relative path, and update a marked README block.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
urlURL to open and capture.yes
capture_pathRepo-relative path where the captured asset should be written.yes
marker_nameMarker name used for the README block, such as screenshot or hero.noscreenshot
capture_formatWhether to capture a static PNG image or an animated GIF.noimage
markdown_pathRepo-relative path to the Markdown file to update.noREADME.md
viewport_widthBrowser viewport width in pixels.no1440
viewport_heightBrowser viewport height in pixels.no900
wait_untilPlaywright waitUntil value for page navigation.nonetworkidle
navigation_retriesNumber of times to retry page navigation after the initial attempt fails.no0
navigation_retry_delay_msDelay between navigation retry attempts in milliseconds.no1000
delay_msAdditional delay after navigation before taking the screenshot.no0
gif_duration_msDuration of the GIF capture in milliseconds when capture_format is gif.no1000
browser_pathOptional explicit browser executable path.no
commit_changesWhether to commit and push updates to the currently checked-out branch.nofalse
commit_messageCommit message used when commit_changes is true.nodocs: update screenshots
commit_author_nameCommit author name used when commit_changes is true.nogithub-actions[bot]
commit_author_emailCommit author email used when commit_changes is true.no41898282+github-actions[bot]@users.noreply.github.com
namedescription
capture_pathRepo-relative asset path written by the action.
committedWhether the action created and pushed a commit.