Zum Inhalt springen

Screenshots mit GitHub Actions

Erfassen Sie Deployment-Vorschauen in Pull-Request-Workflows und machen Sie visuelle Änderungen für Reviewer sichtbar.

Automatische Screenshots machen visuelle Änderungen schon im Review eines Pull Requests sichtbar. Die Action von Ironfang Render erfasst Vorschau-URLs, ergänzt die Ergebnisse in der Job-Zusammenfassung und lädt die Bilder als Build-Artefakte hoch.

Ironfang Render in Ihren Workflow einbinden

In jeden Workflow einfügen, der eine Vorschau-URL hat.

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

Der Schritt ergänzt die Job-Zusammenfassung um eine Tabelle mit jeder Aufnahme, ihrer Dateigröße und ihrer Renderzeit. Außerdem lädt er die Bilder als Build-Artefakte hoch, die Sie vom Pull Request aus prüfen können.

Wiederholte Läufe und der Cache

Jede Aufnahme zählt einmal zum Zähler render.screenshot, und jedes Konto hat jeden Monat ein kostenloses Kontingent an Screenshots. Eine identische Anfrage, die innerhalb von zehn Minuten wiederholt wird, kann aus dem Cache kommen und zählt dann nicht, ein Treffer im Cache ist aber nie garantiert. Rechnen Sie also damit, dass ein erneuter Workflow-Lauf seine Aufnahmen wieder zählt.

cURL in anderen CI-Systemen verwenden

Jeder CI-Runner mit cURL kann denselben Endpunkt aufrufen, auch GitLab CI und Jenkins.

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

Weiterlesen