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 GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Sep 24, 2025
License
Apache 2.0

Pinned Snippet

workflow.ymlSHA-pinned
uses: cloudposse-github-actions/screenshot@6240c8f6d9d557816eb0692a64d24386e0f3ebb6 # no releases — HEAD as of 2026-07-11

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
urlURL of the HTML content to convert to an image. Use file:// for local filesyes
cssCustom CSS overridesno
customizationsString representation of a YAML or JSON map of CSS paths (key) and replacement (value)no
outputOutput image file pathnoscreenshot.png
outputTypeOutput image typepng
omitBackgroundOmit the browser default background. Enable to support transparency.true
viewportWidthViewport width in pixelsyes
viewportHeightViewport height in pixelsyes
imageQualityQuality of the output image (1-100, applicable for JPEG)no
consoleOutputEnabledWhether or not to output the browser console logtrue
deviceScaleFactorSpecifies 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.no2
fullPageScreen capture the entire page by scrolling downfalse
waitForTimeoutNumber of milliseconds to delay before taking screenshot500
puppeteerImageDocker image to run puppeteer. See https://github.com/puppeteer/puppeteer/pkgs/container/puppeteerghcr.io/puppeteer/puppeteer:22.13.1
namedescription
fileFile containing the generated screenshot