remotestate/Pencil Actions
Automatically preview .pen design files in pull requests
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token for API access (usually secrets.GITHUB_TOKEN) | yes | — |
| review-mode | Review mode: "full" (render all frames) or "diff" (show only changes with before/after comparison) | no | diff |
| service-url | Screenshot rendering API URL | no | https://pencil.remotestate.com |
| service-api-key | API key for higher limits (5,000/month). Without a key, free tier gives 1,000/month via GitHub OIDC (requires "permissions: id-token: write"). Contact us for 10,000/month. | no | — |
| comment-mode | How to post comments: "create" (always new), "update" (update existing), "none" (skip commenting) | no | update |
| comment-id | Unique identifier to namespace PR comments. Allows multiple workflows to post separate comments on the same PR without overwriting each other. | no | "" |
| upload-artifacts | Whether to upload screenshots as workflow artifacts | no | true |
| include-deleted | Whether to show deleted files in the comment | no | true |
| max-frames-per-file | Maximum number of frames to render per .pen file (0 for unlimited) | no | 20 |
| image-format | Output image format: "webp" (smallest), "png", or "jpeg" | no | webp |
| image-scale | Export scale: 1, 2, or 3 | no | 2 |
| image-quality | Image quality for webp/jpeg (1-100) | no | 90 |
Outputs
| name | description |
|---|---|
| screenshots-path | Path to the directory containing generated screenshots |
| changed-files | JSON array of changed .pen files |
| frames-rendered | Total number of frames rendered |
| comment-id | ID of the created/updated PR comment |