Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync desktop wallet translations with Crowdin #644

Merged
merged 1 commit into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/translations-sync-dw.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Sync translations in desktop wallet

on:
workflow_dispatch:
push:
paths: ['apps/desktop-wallet/locales/**']
branches: [next]
Comment on lines +5 to +7
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This action will run only if there are changes in the files in the defined paths when a push in the next branch happens, or when run manually (workflow_dispatch).


permissions:
contents: write
pull-requests: write
Comment on lines +9 to +11
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is needed so that the action can push to a branch and create PRs.


jobs:
sync-translations:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Sync sources and translations
uses: crowdin/github-action@v2
with:
config: 'apps/desktop-wallet/crowdin.yml'
upload_sources: true
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will upload new translation strings added to the English JSON.

upload_translations: true
Copy link
Member Author

@nop33 nop33 Jun 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will upload any translations that were added in the corresponding language JSON files. This is basically essential for the initialization of the languages. Any further updates on these files should happen on Crowdin directly (in principal). But nothing stops us accepting PRs from translators that update translation files directly instead of going through Crowdin (for example, you can already add the French translations, it'd be an overhead to have to go through Crowdin in each of your PRs).

download_translations: true
localization_branch_name: l10n_crowdin_translations
create_pull_request: true
pull_request_title: 'New Crowdin translations'
pull_request_body: 'New translations from https://crowdin.com/project/alephium-desktop-wallet.'
pull_request_base_branch_name: 'next'
Comment on lines +26 to +31
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this config easily reads, if there are any new translations added in Crowdin, they will be downloaded and a new PR will be created with the changes.

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
2 changes: 2 additions & 0 deletions apps/desktop-wallet/.env.example
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
VITE_USE_LOCAL_ANNOUNCEMENT_FILE=false # Turn this to true to use local announcement file for development
CROWDIN_PROJECT_ID=
CROWDIN_PERSONAL_TOKEN=
Comment on lines +2 to +3
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These 2 secrets were added in our GitHub actions settings in the frontend repo.

126 changes: 126 additions & 0 deletions apps/desktop-wallet/crowdin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
#
# Your Crowdin credentials
#
'project_id_env': 'CROWDIN_PROJECT_ID'
'api_token_env': 'CROWDIN_PERSONAL_TOKEN'
'base_path': '.'
'base_url': 'https://api.crowdin.com'

#
# Choose file structure in Crowdin
# e.g. true or false
#
'preserve_hierarchy': true

#
# Files configuration
#
files: [
{
#
# Source files filter
# e.g. "/resources/en/*.json"
#
'source': '/locales/en-US/translation.json',

#
# Where translations will be placed
# e.g. "/resources/%two_letters_code%/%original_file_name%"
#
'translation': '/locales/%locale%/%original_file_name%'
#
# Files or directories for ignore
# e.g. ["/**/?.txt", "/**/[0-9].txt", "/**/*\?*.txt"]
#
# "ignore": [],

#
# The dest allows you to specify a file name in Crowdin
# e.g. "/messages.json"
#
# "dest": "",

#
# File type
# e.g. "json"
#
# "type": "",

#
# The parameter "update_option" is optional. If it is not set, after the files update the translations for changed strings will be removed. Use to fix typos and for minor changes in the source strings
# e.g. "update_as_unapproved" or "update_without_changes"
#
# "update_option": "",

#
# Start block (for XML only)
#

#
# Defines whether to translate tags attributes.
# e.g. 0 or 1 (Default is 1)
#
# "translate_attributes": 1,

#
# Defines whether to translate texts placed inside the tags.
# e.g. 0 or 1 (Default is 1)
#
# "translate_content": 1,

#
# This is an array of strings, where each item is the XPaths to DOM element that should be imported
# e.g. ["/content/text", "/content/text[@value]"]
#
# "translatable_elements": [],

#
# Defines whether to split long texts into smaller text segments
# e.g. 0 or 1 (Default is 1)
#
# "content_segmentation": 1,

#
# End block (for XML only)
#

#
# Start .properties block
#

#
# Defines whether single quote should be escaped by another single quote or backslash in exported translations
# e.g. 0 or 1 or 2 or 3 (Default is 3)
# 0 - do not escape single quote;
# 1 - escape single quote by another single quote;
# 2 - escape single quote by backslash;
# 3 - escape single quote by another single quote only in strings containing variables ( {0} ).
#
# "escape_quotes": 3,

#
# Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.
# e.g. 0 or 1 (Default is 0)
# 0 - do not escape special characters
# 1 - escape special characters by a backslash
#
# "escape_special_characters": 0
#

#
# End .properties block
#

#
# Does the first line contain header?
# e.g. true or false
#
# "first_line_contains_header": true,

#
# for spreadsheets
# e.g. "identifier,source_phrase,context,uk,ru,fr"
#
# "scheme": "",
}
]