Skip to content

Release v1.16.0-beta.16: Send to GPS collision handling + Custom Wayp… #54

Release v1.16.0-beta.16: Send to GPS collision handling + Custom Wayp…

Release v1.16.0-beta.16: Send to GPS collision handling + Custom Wayp… #54

Workflow file for this run

name: Screenshots
# Generates marketing/doc screenshots (site/ User Guide) from the
# screenshot suite in tests/screenshots/, then opens a Pull Request with the
# refreshed PNGs against `beta` — it never pushes directly. Review the
# "Files changed" tab on the PR (GitHub renders image diffs) and merge if
# it looks right; check in particular that main-window.png isn't showing a
# blank map (that needs outbound internet to OpenStreetMap during the run).
#
# Runs automatically on every release tag (mirrors build.yml's `v*` trigger),
# and can also be run manually from the Actions tab → "Screenshots" →
# "Run workflow" any time you just want fresh screenshots without a release.
on:
push:
tags:
- "v*"
workflow_dispatch:
inputs:
branch:
description: "Branch to capture screenshots from (manual runs only)"
required: false
default: ""
permissions:
contents: write
pull-requests: write
jobs:
capture:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
ref: ${{ inputs.branch || github.ref }}
- uses: actions/setup-python@v7
with:
python-version: "3.12"
cache: pip
- uses: ./.github/actions/setup-qt
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[dev]"
- name: Capture screenshots
env:
QT_QPA_PLATFORM: xcb
OPENSAK_SCREENSHOT_DIR: ${{ github.workspace }}/screenshot-output
run: |
xvfb-run -a --server-args="-screen 0 1440x1024x24" \
pytest tests/screenshots -v
# Kept as a debug aid — if the PR step below ever fails, the raw PNGs
# are still recoverable from this run's artifact.
- uses: actions/upload-artifact@v7
with:
name: opensak-screenshots
path: screenshot-output/*.png
retention-days: 14
- name: Copy into site assets
run: |
mkdir -p site/assets/screenshots
cp screenshot-output/*.png site/assets/screenshots/
- name: Open PR with refreshed screenshots
uses: peter-evans/create-pull-request@v8
with:
token: ${{ secrets.GITHUB_TOKEN }}
base: beta
branch: auto/screenshots-${{ github.run_id }}
title: "docs: refresh screenshots (${{ github.ref_name }})"
commit-message: "docs: refresh screenshots (${{ github.ref_name }})"
add-paths: |
site/assets/screenshots/*.png
labels: documentation
body: |
Auto-generated by the Screenshots workflow, triggered by `${{ github.ref_name }}`.
**Before merging, check the "Files changed" tab:**
- `main-window.png` should show a real OpenStreetMap tile background, not a blank/grey area.
- Nothing looks cropped, blurry, or visually broken.
If something's off, close this PR without merging and re-run the workflow manually
(Actions → Screenshots → Run workflow) once the underlying issue is fixed.