Skip to content
Ironfang

Guide

Screenshots in GitHub Actions

Capture deployment previews during pull request workflows and make visual changes available to reviewers.

Automated screenshots make visual changes available during pull request review. The Ironfang Render action captures preview URLs, adds results to the job summary and uploads the images as build artefacts.

Add Ironfang Render to your workflow

Add to any workflow that has a preview URL.

- uses: ironfang-ltd/renderwolf-action@v1
  with:
    api-key: ${{ secrets.RENDERWOLF_API_KEY }}
    urls: |
      https://preview.example.com/
      https://preview.example.com/pricing
    width: 1440
    full-page: true
    format: webp

The step adds a table to the job summary with each capture, file size, render time and credit usage. It also uploads the images as build artefacts for review from the pull request.

Cached re-runs do not use credits

Identical requests served from cache use zero credits. Re-running a workflow against an unchanged page therefore does not reduce the plan allowance.

Use cURL in other CI systems

Any CI runner with cURL can call the same endpoint, including GitLab CI and Jenkins.

curl -X POST https://api.ironfang.uk/renderwolf/v1/screenshot \
  -H "Authorization: Bearer $RENDERWOLF_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://preview.example.com", "width": 1440, "full_page": true}' \
  --output preview.png

Next