fix: Replace with a supported robust solution #3
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: Pull Translations from Tolgee | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: '0 0 * * *' # Run daily at midnight UTC | ||
| workflow_dispatch: # Allows manual trigger | ||
|
|
||
| jobs: | ||
| pull_translations: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install Tolgee CLI | ||
| run: npm install -g @tolgee/cli | ||
|
|
||
| - name: Pull Universe translations from Tolgee | ||
| env: | ||
| TOLGEE_API_KEY: ${{ secrets.TOLGEE_API_KEY }} | ||
| TOLGEE_PROJECT_ID: ${{ secrets.TOLGEE_UNIVERSE_PROJECT_ID }} | ||
| run: | | ||
| mkdir -p public/locales | ||
| tolgee export --path "public/locales/{lang}" --format json --structure namespace --empty-as-source | ||
| echo "::set-output name=universe_changed::true" | ||
| id: universe_pull | ||
|
|
||
| - name: Pull WXTM Bridge translations from Tolgee | ||
| env: | ||
| TOLGEE_API_KEY: ${{ secrets.TOLGEE_API_KEY }} | ||
| TOLGEE_PROJECT_ID: ${{ secrets.TOLGEE_WXTM_BRIDGE_PROJECT_ID }} | ||
| run: | | ||
| mkdir -p wxtm-bridge-frontend/public/locales | ||
| tolgee export --path "wxtm-bridge-frontend/public/locales/{lang}" --format json --structure namespace --empty-as-source | ||
| echo "::set-output name=wxtm_changed::true" | ||
| id: wxtm_pull | ||
|
|
||
| - name: Commit changes (if any) | ||
| if: steps.universe_pull.outputs.universe_changed == 'true' || steps.wxtm_pull.outputs.wxtm_changed == 'true' | ||
| uses: stefanzweifel/git-auto-commit-action@v4 | ||
| with: | ||
| commit_message: "chore(i18n): Update translations from Tolgee" | ||
| branch: main # Or your desired target branch |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: Push English Keys to Tolgee | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'public/locales/en/*.json' # For Tari Universe | ||
| - 'wxtm-bridge-frontend/public/locales/en/*.json' # For WXTM Bridge | ||
| workflow_dispatch: # Allows manual trigger | ||
|
|
||
| jobs: | ||
| push_keys: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install Tolgee CLI | ||
| run: npm install -g @tolgee/cli | ||
|
|
||
| - name: Push Universe English keys to Tolgee | ||
| env: | ||
| TOLGEE_API_KEY: ${{ secrets.TOLGEE_API_KEY }} | ||
| TOLGEE_PROJECT_ID: ${{ secrets.TOLGEE_UNIVERSE_PROJECT_ID }} | ||
| run: | | ||
| if [ -d "public/locales/en" ]; then | ||
| tolgee import --path "public/locales/en" --format json --language en --force-update | ||
| else | ||
| echo "Universe English locale directory not found. Skipping." | ||
| fi | ||
|
|
||
| - name: Push WXTM Bridge English keys to Tolgee | ||
| env: | ||
| TOLGEE_API_KEY: ${{ secrets.TOLGEE_API_KEY }} | ||
| TOLGEE_PROJECT_ID: ${{ secrets.TOLGEE_WXTM_BRIDGE_PROJECT_ID }} | ||
| run: | | ||
| if [ -d "wxtm-bridge-frontend/public/locales/en" ]; then | ||
| tolgee import --path "wxtm-bridge-frontend/public/locales/en" --format json --language en --force-update | ||
| else | ||
| echo "WXTM Bridge English locale directory not found. Skipping." | ||
| fi | ||
|
|
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,114 +1,53 @@ | ||||||||
| # Internationalization (i18n) Management with Tolgee | ||||||||
|
|
||||||||
| This repository previously contained a custom i18n pipeline (`aiteen`), which has been deprecated and replaced by **Tolgee**, an established open-source i18n management platform. Tolgee provides a robust solution for managing translations across Tari projects (Universe, WXTM Bridge, and future applications) with integrated AI translation, a review workflow, and full CI/CD support. | ||||||||
|
|
||||||||
| ## Solution Rationale: Why Tolgee? | ||||||||
|
|
||||||||
| Tolgee was selected as the replacement solution due to its comprehensive features that directly address the pain points of the previous custom pipeline: | ||||||||
|
|
||||||||
| 1. **Robust Platform:** Tolgee offers a dedicated web interface for translation management, making it easy for non-developers to contribute, review, and approve translations. | ||||||||
| 2. **Seamless AI Integration:** It has built-in support for AI translation services (like OpenAI), allowing for automated, context-aware translation of missing keys directly within the platform. | ||||||||
| 3. **Review Workflow:** Tolgee provides clear states for translations (untranslated, translated, reviewed), enabling a structured review and approval process before translations are finalized. Permissions can be set to control who can perform reviews. | ||||||||
| 4. **CI/CD Integration:** With its powerful CLI tool and API, Tolgee integrates natively into GitHub Actions, automating the detection of new English strings and the synchronization of translated content. | ||||||||
| 5. **Multi-Project Support:** Tolgee handles multiple projects (e.g., Tari Universe, WXTM Bridge) within a single instance, allowing for shared languages and streamlined management across the ecosystem. | ||||||||
| 6. **Flexible Locale Structure:** It supports various file formats, including JSON, and can be configured to work with existing project structures (`public/locales/{lang}/`). | ||||||||
|
|
||||||||
| ## New i18n Workflow with Tolgee | ||||||||
|
|
||||||||
| The new workflow focuses on automating translation management via Tolgee and GitHub Actions. | ||||||||
|
|
||||||||
| ### 1. Add New English Keys | ||||||||
|
|
||||||||
| Developers add new strings directly into their English locale JSON files (e.g., `public/locales/en/common.json`). When these changes are pushed to a `main` branch (or merged via PR), a GitHub Action automatically pushes these new keys to Tolgee. | ||||||||
|
|
||||||||
| ### 2. Automatic AI Translation & Review | ||||||||
|
|
||||||||
| Once new keys are pushed to Tolgee: | ||||||||
| * Tolgee automatically detects missing translations for other configured languages. | ||||||||
| * Configured AI translation (e.g., OpenAI) generates initial translations. | ||||||||
| * Translators or project managers log into the Tolgee UI to review, refine, and approve these AI-generated translations. The review process ensures high-quality output before deployment. | ||||||||
|
|
||||||||
| ### 3. Pulling Translations into Projects | ||||||||
|
|
||||||||
| Periodically (e.g., daily schedule) or manually, a GitHub Action runs to pull all approved translations from Tolgee back into the respective project repositories. This action updates the locale JSON files for all languages. | ||||||||
|
|
||||||||
| ### 4. Integration with CI (GitHub Actions) | ||||||||
|
|
||||||||
| Two primary GitHub Actions workflows are now in place: | ||||||||
|
|
||||||||
| * **`push-english-keys.yml`**: Watches for changes in English locale files in `public/locales/en` (Universe) and `wxtm-bridge-frontend/public/locales/en` (WXTM Bridge) and automatically pushes new/updated keys to Tolgee. | ||||||||
| * **`pull-translations.yml`**: Periodically (or on demand) pulls all reviewed translations from Tolgee, updates the locale files in both projects (`public/locales/{lang}/` and `wxtm-bridge-frontend/public/locales/{lang}/`), and commits the changes. | ||||||||
|
|
||||||||
| ## Deprecation of Legacy Scripts | ||||||||
|
|
||||||||
| The custom Python scripts (`i18n_checker.py`, `i18n_translator.py`, `i18n_patch_locales.py`, `i18n_qa.py`) previously used for Aiteen are now deprecated. All functionality related to auditing, translating, patching, and QA is now handled by the Tolgee platform and its integrated CI workflows. | ||||||||
|
|
||||||||
| ## Requirements for Tolgee Integration | ||||||||
|
|
||||||||
| * **Tolgee Instance:** A running Tolgee instance (cloud or self-hosted). | ||||||||
| * **Tolgee API Key:** An API key with appropriate permissions (read/write keys, languages, translations) to be set as a GitHub Secret (`TOLGEE_API_KEY`). | ||||||||
| * **Tolgee Project ID:** The Project ID(s) for your Tolgee project(s), to be set as GitHub Secrets (`TOLGEE_UNIVERSE_PROJECT_ID`, `TOLGEE_WXTM_BRIDGE_PROJECT_ID`). | ||||||||
|
There was a problem hiding this comment. The
Suggested change
|
||||||||
| * **GitHub Token Permissions:** The `pull-translations.yml` workflow commits updated translations back to the repository and requires `contents: write` permissions for the `GITHUB_TOKEN`. If the default token lacks this, configure a Personal Access Token (PAT) as `GITHUB_TOKEN`. | ||||||||
|
|
||||||||
| Refer to the GitHub Actions workflows in `.github/workflows/` for detailed implementation. | ||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The custom Python scripts (
i18n_checker.py,i18n_translator.py, etc.) are now deprecated and replaced by the Tolgee integration. To maintain a clean repository and avoid confusion for future contributors, it is recommended to remove these files in this pull request if they are no longer required for the transition.