Skip to content

ci: add screenshot gallery GitHub Pages deploy#894

Open
Krupakar-Reddy-S wants to merge 1 commit intoSeedSigner:devfrom
Krupakar-Reddy-S:ci/screenshot-gallery-deploy
Open

ci: add screenshot gallery GitHub Pages deploy#894
Krupakar-Reddy-S wants to merge 1 commit intoSeedSigner:devfrom
Krupakar-Reddy-S:ci/screenshot-gallery-deploy

Conversation

@Krupakar-Reddy-S
Copy link
Copy Markdown

Description

Problem or Issue being addressed

The screenshot generator (tests/screenshot_generator/generator.py) already renders all views for every detected locale and produces gallery READMEs with translation completion percentages. CI runs it on every push and saves the output as artifacts. But there's no public-facing gallery — translators on Transifex can't see their work rendered visually.

Solution

Adds a new workflow (.github/workflows/screenshots.yml) that:

  1. Triggers on push to dev
  2. Generates screenshots for all locales
  3. Renames README.md to index.md and fixes internal links for clean directory URLs
  4. Builds HTML via actions/jekyll-build-pages (renders markdown + images)
  5. Deploys to GitHub Pages via actions/deploy-pages

The index page lists all detected locales with links to per-locale galleries. Each locale gallery shows translation completion percentage and all screenshot sections (Main Menu, Seed, PSBT, Tools, Settings, Misc Error views).

Additional Information

  • GitHub Pages must be enabled by a maintainer: Settings > Pages > Source: "GitHub Actions". The workflow will not deploy until this is done.
  • Once enabled, the gallery will be reachable at https://seedsigner.github.io/seedsigner/
  • Tested on fork: https://krupakar-reddy-s.github.io/seedsigner/
  • This is a separate workflow from tests.yml — keeps deploy logic isolated and only triggers on dev pushes, not PRs.

Screenshots

Screenshot 2026-04-03 at 9 01 27 PM (2)

Screenshot 2026-04-03 at 9 01 36 PM (2)

Screenshot 2026-04-03 at 9 01 43 PM (2)

Screenshot 2026-04-03 at 9 02 07 PM (2)


This pull request is categorized as a:

  • New feature
  • Bug fix
  • Code refactor
  • Documentation
  • Other

Checklist

I ran pytest locally

  • All tests passed before submitting the PR
  • I couldn't run the tests
  • N/A

I included screenshots of any new or modified screens

Should be part of the PR description above.

  • Yes
  • No
  • N/A

I added or updated tests

Any new or altered functionality should be covered in a unit test. Any new or updated sequences require FlowTests.

  • Yes
  • No, I’m a fool
  • N/A

I tested this PR hands-on on the following platform(s):


I have reviewed these notes:

  • Keep your changes limited in scope.
  • If you uncover other issues or improvements along the way, ideally submit those as a separate PR.
  • The more complicated the PR, the harder it is to review, test, and merge.
  • We appreciate your efforts, but we're a small team of volunteers so PR review can be a very slow process.
  • Please only "@" mention a contributor if their input is truly needed to enable further progress.
  • I understand

Thank you! Please join our Devs' Telegram group to get more involved.

@wolgwang1729
Copy link
Copy Markdown

Nice improvement overall. One optional enhancement: can we add SeedSigner branding (logo/header styling) to the generated Pages site so it feels consistent with the main website?

Deferring to maintainers on product value and prioritisation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants