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 GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| url | URL to open and capture. | yes | — |
| capture_path | Repo-relative path where the captured asset should be written. | yes | — |
| marker_name | Marker name used for the README block, such as screenshot or hero. | no | screenshot |
| capture_format | Whether to capture a static PNG image or an animated GIF. | no | image |
| markdown_path | Repo-relative path to the Markdown file to update. | no | README.md |
| viewport_width | Browser viewport width in pixels. | no | 1440 |
| viewport_height | Browser viewport height in pixels. | no | 900 |
| wait_until | Playwright waitUntil value for page navigation. | no | networkidle |
| navigation_retries | Number of times to retry page navigation after the initial attempt fails. | no | 0 |
| navigation_retry_delay_ms | Delay between navigation retry attempts in milliseconds. | no | 1000 |
| delay_ms | Additional delay after navigation before taking the screenshot. | no | 0 |
| gif_duration_ms | Duration of the GIF capture in milliseconds when capture_format is gif. | no | 1000 |
| browser_path | Optional explicit browser executable path. | no | — |
| commit_changes | Whether to commit and push updates to the currently checked-out branch. | no | false |
| commit_message | Commit message used when commit_changes is true. | no | docs: update screenshots |
| commit_author_name | Commit author name used when commit_changes is true. | no | github-actions[bot] |
| commit_author_email | Commit author email used when commit_changes is true. | no | 41898282+github-actions[bot]@users.noreply.github.com |
Outputs
| name | description |
|---|---|
| capture_path | Repo-relative asset path written by the action. |
| committed | Whether the action created and pushed a commit. |