feat: update all languages in Weblate, but only offer supported ones in securedrop-admin sdconfig
#6557
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
update_from_weblate() now stages changes (a) for all locales updated from the securedrop/securedrop component but (b) for only supported locales updated from the securedrop/desktop component, since this link is defined explicitly in the I18N_CONF file. commit_changes(), which is called only from update_from_weblate(), now takes a list of paths to check for staged changes and returns if "git commit" would be a no-op.
cfm
added
i18n
Existing tests check for the availability of the de_DE, es_ES, and fr_FR locales, so we mark them as "supported_locales". Some tests need to be passed "tmpdir" in order to instantiate a fully-parameterized SiteConfig.
cfm
force-pushed
the
6387-supported-languages
branch
from
dc64ca5 to
01ba0bd
Compare
eaon
approved these changes
Sep 22, 2022
There was a problem hiding this comment.
Took my time with this one because I had no prior experience with our i18n/l10n infrastructure. Happy to report that the test plan checks out, and the changes seem like a good pragmatic next step to improve admin-facing and developer-facing systems. Thanks @cfm!
4 tasks
cfm
added a commit
to freedomofpress/securedrop-dev-docs
that referenced
this pull request
Oct 5, 2022
cfm
added a commit
to freedomofpress/securedrop-dev-docs
that referenced
this pull request
Oct 5, 2022
After freedomofpress/securedrop#6557, in lieu of a Venn diagram.
cfm
added a commit
to freedomofpress/securedrop-dev-docs
that referenced
this pull request
Oct 5, 2022
After freedomofpress/securedrop#6557, in lieu of a Venn diagram. I regret that I did not manage to use identical terminology between freedomofpress/securedrop#6406 and freedomofpress/securedrop#6557.
|
Looks like Arabic didn't make it into i18n.json. Was that by design or an oversight? |
This was referenced Oct 11, 2022
cfm
added a commit
to freedomofpress/securedrop-dev-docs
that referenced
this pull request
Oct 19, 2022
cfm
added a commit
to freedomofpress/securedrop-dev-docs
that referenced
this pull request
Oct 19, 2022
After freedomofpress/securedrop#6557, in lieu of a Venn diagram. I regret that I did not manage to use identical terminology between freedomofpress/securedrop#6406 and freedomofpress/securedrop#6557.
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.
Status
Ready for review
Description of Changes
Towards #6156, which (with these changes) should be completed automatically as part of the v2.5.0 localization cycle.
Closes #6387 by:
securedrop/i18n.json;i18n_tool.py update-from-weblateto pull translations for all locales available for translation in Weblate; thereby alsoi18n_tool.py translate-{messages,desktop}to update source strings for all locales available for translation in Weblate; whilesecuredrop-admin sdconfigto allow administrators to select only those languages both present (in thesecuredroprepository) and supported (ini18n.json).Testing
securedrop-admin sdconfigThis is the higher priority for testing, since it is an administrator-facing change.
6387-supported-languages.securedrop-admin sdconfigand attempt to enable a nonexistent locale (e.g.,foo).securedrop-admin sdconfigand attempt to enable any two or more supported locales (e.g.,en_US de_DE ro).securedrop/translations. Then runsecuredrop-admin sdconfig.supported_localesentry insecuredrop/i18n.json. Then runsecuredrop-admin sdonfig.i18n_tool.pyThis is the lower priority for testing, since it's a tooling change we can tweak in place if necessary, including during the localization cycle.
Run
securedrop/i18n_tool.py update-from-weblate.An
INFOis logged to the standard output for each unsupported language like:securedrop/securedrop/i18n_tool.py
Lines 327 to 328 in efdc952
Changes to all languages, not only supported ones, are fetched, checked out, staged, and committed.
Deployment
These changes should be invisible to the administrators of any correctly-configured SecureDrop instance. If (e.g.) an instance has custom translations installed, these will be unavailable after the next
securedrop-admin sdconfig. If in the future we drop support for a language we currently support, administrators will have to update their configured locales on their nextsecuredrop-admin sdconfig.Checklist
If you made changes to the server application code:
make lint) and tests (make test) pass in the development containerIf you made changes to
securedrop-admin:make -C admin test) pass in the admin development containerIf you made non-trivial code changes:
Choose one of the following:
Documentation will follow from me and/or @eaon as Localization Managers for the v2.5.0 release.