DocumentationAutomation
GitHub Actions
Check store screenshots on every pull request with annotations, keep the images as build artifacts and upload them from a release workflow.
Two workflows cover most projects: one checks and exports the screenshots on every pull request, the other uploads them to the stores when you release. How to install the CLI and what it offers CI in general: Automation.
Checking and exporting on pull requests
name: Store screenshots
on:
pull_request:
paths: ["store-screens/**"]
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Install vitrine
run: |
v=1.0.0
base=https://github.com/vitrinestudio-app/vitrine/releases/download/v$v
curl -sSfLO "$base/vitrine-cli_linux_x86_64.tar.gz"
curl -sSfL "$base/SHA256SUMS.txt" | grep ' vitrine-cli_linux_x86_64.tar.gz$' | sha256sum -c -
tar xzf vitrine-cli_linux_x86_64.tar.gz
echo "$PWD/vitrine-cli_$v" >> "$GITHUB_PATH"
- run: vitrine --project store-screens validate --format github --strict
- run: vitrine --project store-screens export --out export
- uses: actions/upload-artifact@v4
with:
name: store-screenshots
path: export
--format githubturns every finding into an annotation in the pull request, at the line inproject.yamlthat defines the element or target. GitHub shows at most 10 error and 10 warning annotations per step. Errors come first; the full report is always in the log.--strictfails the job on warnings too (exit code 1).- On an arm64 runner (
ubuntu-24.04-arm) takevitrine-cli_linux_aarch64.tar.gz, on a macOS runnervitrine-cli_macos_universal.tar.gz– see the archive list.
The ready-made action
vitrinestudio-app/vitrine-github-action
does the install step (checksum, caching; it picks the arm64 or static
build where needed) and the validate/export steps in one uses:; it is also
listed on the GitHub Marketplace. @v1
follows the latest 1.x release of the action; version pins the CLI:
- uses: vitrinestudio-app/vitrine-github-action@v1
with:
version: 1.0.0
project: store-screens
validate: true
export: true
Uploading from a release workflow
Store the App Store Connect key as repository or environment secrets and
pass them to vitrine upload as environment variables (all variables:
Uploading from CI). An environment with required
reviewers makes a person approve every run before the job starts:
name: Upload store screenshots
on: workflow_dispatch
jobs:
upload:
runs-on: ubuntu-latest
environment: app-store # required reviewers approve each run
steps:
- uses: actions/checkout@v5
- name: Install vitrine
run: |
v=1.0.0
base=https://github.com/vitrinestudio-app/vitrine/releases/download/v$v
curl -sSfLO "$base/vitrine-cli_linux_x86_64.tar.gz"
curl -sSfL "$base/SHA256SUMS.txt" | grep ' vitrine-cli_linux_x86_64.tar.gz$' | sha256sum -c -
tar xzf vitrine-cli_linux_x86_64.tar.gz
echo "$PWD/vitrine-cli_$v" >> "$GITHUB_PATH"
- name: Upload
env:
VITRINE_ASC_KEY_ID: ${{ secrets.ASC_KEY_ID }}
VITRINE_ASC_ISSUER_ID: ${{ secrets.ASC_ISSUER_ID }}
VITRINE_ASC_KEY: ${{ secrets.ASC_KEY }}
run: |
vitrine --project store-screens upload plan --store apple --remote --format json > plan.json
vitrine --project store-screens upload execute --confirm "$(jq -r .confirm_token plan.json)" --yes
- uses: actions/upload-artifact@v4
if: always()
with:
name: upload-plan
path: plan.json
The plan step exits with 1 when the plan is blocked, so nothing is uploaded.
For Google Play, set VITRINE_PLAY_SERVICE_ACCOUNT and use
--store google.
Device frames
The runner has no Apple bezels of its own. Store the ones your project uses in the repository (private repositories only), or use the built-in frames – see Device frames in CI.