fix: Replace with a supported robust solution#3
fix: Replace with a supported robust solution#3ledgerpilot wants to merge 3 commits intotari-project:mainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the repository's internationalization documentation to reflect the migration from a custom Python-based pipeline to Tolgee, detailing the new automated workflow and GitHub Actions integration. The review feedback identifies several improvement opportunities, including correcting filesystem paths for locale directories, removing deprecated legacy scripts to maintain repository cleanliness, and documenting the specific GitHub Action permissions required for committing translations.
| * **`push-english-keys.yml`**: Watches for changes in English locale files in `tari-project/universe` and `tari/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 `tari-project/universe` and `tari/wxtm-bridge`, and commits the changes. |
There was a problem hiding this comment.
The paths tari-project/universe and tari/wxtm-bridge appear to be project names or repository slugs rather than the actual directory paths within this repository. Based on the PR description and the previous README version, the actual paths are likely public/locales/en and wxtm-bridge-frontend/public/locales/en. Updating these to the actual filesystem paths will make the documentation more accurate and helpful for developers.
| * **`push-english-keys.yml`**: Watches for changes in English locale files in `tari-project/universe` and `tari/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 `tari-project/universe` and `tari/wxtm-bridge`, and commits the changes. | |
| * **push-english-keys.yml**: Watches for changes in English locale files in `public/locales/en` and `wxtm-bridge-frontend/public/locales/en` 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 `public/locales` and `wxtm-bridge-frontend/public/locales`, and commits the changes. |
| --en-locale-path /Users/possum/Projects/tari/wxtm-bridge/wxtm-bridge-frontend/public/locales/en \ | ||
| --base-path /Users/possum/Projects/tari/wxtm-bridge/wxtm-bridge-frontend/public/locales \ | ||
| --output-dir locale_comparison_wxtm | ||
| 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. |
There was a problem hiding this comment.
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.
| --csv-file locale_comparison_wxtm/translated_locale_key_comparison_consolidated.csv | ||
| * **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 pull-translations.yml workflow requires write permissions to commit updated translations back to the repository. It is a good practice to document this requirement, specifically the need for contents: write permissions for the GITHUB_TOKEN or the use of a Personal Access Token (PAT).
| * **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`). | |
| * **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`). | |
| * **GitHub Token Permissions:** The GitHub Actions (specifically `pull-translations.yml`) require `contents: write` permissions to commit updated translations back to the repository. |
1 participant
Closes #1
What changed
The Aiteen custom i18n pipeline has been replaced with Tolgee, an established i18n management solution, integrated into GitHub Actions for an automated and review-driven translation workflow. 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: # Al
Files modified
.github/workflows/push-english-keys.yml.github/workflows/pull-translations.ymlREADME.mdDraft PR — please review before merging.