let Weblate pick up screenshots from the repository

[cfm]

Description

As of Weblate 4.18, Weblate can now detect screenshots by mask in the repository linked to a translation component.

Pro: Something else (securedrop/upload-screenshots.py) to delete!

Con: Screenshots would have to live in this repository.

How will this impact SecureDrop users?

No user-facing implications.

How would this affect SecureDrop's threat model?

No threat-model implications, except in the usual sense that code you can delete doesn't have bugs anymore. ;-)

User Stories

As a maintainer, I want to continue offloading as many scripted functions as possible to Weblate.

[legoktm]

Con: Screenshots would have to live in this repository.

Is it possible to point weblate to the docs repo, where many/some of the screenshots already exist?

[cfm]

On Mon, Oct 02, 2023 at 05:22:37PM -0700, Kunal Mehta wrote: Is it possible to point weblate to the docs repo, where many/some of the screenshots already exist?

No, it's a mask within the source repository, just like how Weblate identifies source and translation files. So they'll be duplicated no matter what: - now, between (1) securedrop-docs and (2) Weblate directly via the API, via "update-screenshots.py`; or - in this proposal, between (1) securedrop-docs and (2) this repository, to feed Weblate.

[zenmonkeykstop]

Any chance we could git-submodule it in?

[cfm]

Weblate won't follow submodules, so we'd have to do:

securedrop-docs/      # repository
    securedrop/       # submodule
        screenshots/  # directory

Would that be acceptable? Most contributors would never have to do the git submodule update --init dance. Only we and CI would have to, in order to update and fetch screenshots, respectively. And Weblate would receive them directly in securedrop.

[legoktm]

My concern actually isn't the duplication, it's that we're going to be adding more binary assets to the SD repo adds up when cloning on Tails, etc. (And they live in the repo's .git forever, even when replaced)

Does weblate support Git LFS? Then we could store the screenshots as LFS files, but have people on Tails clone without LFS, so they only get the tiny stubs and not full images.

[legoktm]

But also +1 to getting rid of upload-screenshots and using weblate functionality instead, its one of those weird things that requires special casing (e.g. in securedrop/debian/rules)

[cfm]

No Git LFS support, alas. I've filed WeblateOrg/weblate#10164 suggesting three different approaches that would work for our constraints here.