cloudposse-github-actions/Example composite GitHub action
Generate a browser screenshot using puppeteer of any URL, including local files. Supports custom CSS overrides and Jquery style rewrites of content.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Sep 24, 2025
- License
- Apache 2.0
Pinned Snippet
uses: cloudposse-github-actions/screenshot@6240c8f6d9d557816eb0692a64d24386e0f3ebb6 # no releases — HEAD as of 2026-07-11tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| url | URL of the HTML content to convert to an image. Use file:// for local files | yes | — |
| css | Custom CSS overrides | no | — |
| customizations | String representation of a YAML or JSON map of CSS paths (key) and replacement (value) | no | — |
| output | Output image file path | no | screenshot.png |
| outputType | Output image type | — | png |
| omitBackground | Omit the browser default background. Enable to support transparency. | — | true |
| viewportWidth | Viewport width in pixels | yes | — |
| viewportHeight | Viewport height in pixels | yes | — |
| imageQuality | Quality of the output image (1-100, applicable for JPEG) | no | — |
| consoleOutputEnabled | Whether or not to output the browser console log | — | true |
| deviceScaleFactor | Specifies the device scale factor (pixel ratio) for the web page rendering. It determines how many physical pixels are used to represent a single logical pixel. For example, a device scale factor of 2 means one logical pixel is represented by two physical pixels, commonly used for high-DPI (Retina) displays. A value of 1 uses standard pixel density. This factor affects the resolution and quality of the rendered page or screenshot. | no | 2 |
| fullPage | Screen capture the entire page by scrolling down | — | false |
| waitForTimeout | Number of milliseconds to delay before taking screenshot | — | 500 |
| puppeteerImage | Docker image to run puppeteer. See https://github.com/puppeteer/puppeteer/pkgs/container/puppeteer | — | ghcr.io/puppeteer/puppeteer:22.13.1 |
Outputs
| name | description |
|---|---|
| file | File containing the generated screenshot |