Add Weblate screenshot uploader tool #5450
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eloquence
force-pushed
the
3959-weblate-uploader
branch
from
ca83f8d
to
a49f06c
Compare
rmol
reviewed
Aug 14, 2020
Uploads all page layout test results via Weblate's API, replacing existing screenshots as appropriate by matching filenames against canonicalized titles.
eloquence
force-pushed
the
3959-weblate-uploader
branch
from
a49f06c
to
b464adf
Compare
eloquence
changed the title
eloquence
requested review from
emkll,
kushaldas,
redshiftzero and
zenmonkeykstop
as code owners
|
The script is now rewritten in Python, and also handles the updating of existing screenshots. Looking forward to review & perhaps running in prod soon. :) |
rmol
previously approved these changes
Aug 18, 2020
There was a problem hiding this comment.
This works perfectly. I made a couple of suggestions but am approving without requesting the changes. If you want to make them, I'm happy to rereview.
- Ensure unrestricted access to the Weblate sandbox (infra team).
- Manually delete all screenshots in the sandbox.
- Obtain a sandbox API token and export it to an environment variable
WEBLATE_TOKEN - Export the sandbox URL to
SANDBOX_URL - Generate the screenshots in English via
LOCALES=en_US make translation-test - Run the tool via
securedrop/upload-screenshots.py --token $WEBLATE_TOKEN --baseURL $SANDBOX_URL - Observe that a total of 55 screenshots are newly created by checking the count via
/api/screenshots/(the API has a convenient web UI you can use for this) - Delete some screenshots, and modify another screenshot in a way that you'll be able to later recognize.
- Run the tool again.
- Observe that the screenshots you deleted are re-uploaded, and that the screenshot you modified was modified.
eloquence
force-pushed
the
3959-weblate-uploader
branch
from
15ef8cb
to
eccfba2
Compare
eloquence
force-pushed
the
3959-weblate-uploader
branch
from
9964ce0
to
fd004de
Compare
rmol
approved these changes
Aug 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uploads all page layout test results via Weblate's API, updating existing screenshots as appropriate.
Status
Ready for review. Towards #3959 (resolves it once we complete a single run in production).
Description of Changes
This is done as a standalone Python script, with the upload portion written as a
WeblateUploaderclass that is as generic as possible, in case it is useful for others solving this problem in other contexts.Includes documentation for SecureDrop maintainers, and built-in help.
Test plan
WEBLATE_API_TOKENWEBLATE_BASE_URLLOCALES=en_US make translation-testsecuredrop/upload-screenshots.py/api/screenshots/(the API has a convenient web UI you can use for this)