feat(i18n): added scripts for i18n and more #1448

ciiay · 2025-09-15T22:26:51Z

Hey, I just made a Pull Request!

For RHIDP-8763.

PR Summary: I18n Scripts Enhancement and Translation Sync Fix

Added scripts to collect and upload translation reference JSON files to TMS project
- New two-step workflow: generate JSON files, then push to TMS
- Legacy single-step upload maintained for backward compatibility
Added scripts to download and sync translations with received translation files
- Download with human-readable filenames instead of job IDs
- Automatic deployment to correct plugin directories
- Robust sync from JSON to TypeScript with syntax validation
Added utility scripts for translation workflow management
- Backup file cleanup and management
- Translation file deployment automation
- Enhanced caching to prevent duplicate downloads
Fixed critical path resolution issue in i18n configuration
- Resolved "No such file or directory" errors when running scripts
- Improved script sourcing reliability across different execution contexts
Enhanced translation sync algorithm to prevent file corruption
- Fixed duplicate key errors in TypeScript translation files
- Improved string escaping for special characters and template variables
- Added syntax validation to catch corruption early
Added comprehensive documentation for i18n scripts
- Complete workflow guide with setup instructions
- Quick reference guide for daily use
- Troubleshooting section with common issues and solutions
Updated package.json with new i18n commands
- Added yarn scripts for all new workflow steps
- Included help commands for each script
Updated French translation TypeScript files in global-header plugin
- Fixed corrupted translation file with duplicate keys
- Applied proper translations from TMS
Added .gitignore entries for translation backup files
- Prevents temporary .bak files from being committed

✔️ Checklist

A changeset describing the change and affected packages. (more info)
Added or Updated documentation
Tests for new functionality and regression tests for bug fixes
Screenshots attached (for UI changes)

Testing Guide: I18n Scripts Workflow

Prerequisites

Set up TMS credentials per team guide
Confirm the TMS project ID, and update i18n.config.sh coordinately

Run from repo root

Quick Test Steps

1. Generate and upload JSON files

yarn i18n-generate
ls ui-i18n/1.8/  # Verify JSON files created

yarn i18n-push   # Upload to TMS

⚠️ Note: If testing creates duplicate files in TMS, please delete them after testing

2. Download and sync translations

yarn i18n-download  # Downloads with human-readable names
yarn i18n-deploy    # Deploy to plugin directories
yarn i18n-sync      # Sync JSON → TypeScript

3. Verify quality

# Check syntax and no duplicates
node -c workspaces/global-header/plugins/global-header/src/translations/fr.ts
grep -c "'" workspaces/global-header/plugins/global-header/src/translations/fr.ts | grep -v "duplicate"

4. Test cleanup

yarn i18n-cleanup --dry-run --translations-only

5. Verify app runs

cd workspaces/global-header && yarn start

Success Criteria

✅ JSON files generate without path errors
✅ Translation sync creates valid TypeScript with no duplicate keys
✅ App starts without translation errors
✅ Cleanup utilities work safely

Key Fixes Validated

Path resolution works from any directory
No duplicate keys in synced translation files
Special characters and {{variables}} preserved correctly

rhdh-gh-app · 2025-09-15T22:27:14Z

Missing Changesets

The following package(s) are changed by this PR but do not have a changeset:

@red-hat-developer-hub/backstage-plugin-adoption-insights-common
@red-hat-developer-hub/backstage-plugin-quickstart

See CONTRIBUTING.md for more information about how to add changesets.

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
backend	workspaces/adoption-insights/packages/backend	none	`v0.0.0`
@red-hat-developer-hub/backstage-plugin-adoption-insights-common	workspaces/adoption-insights/plugins/adoption-insights-common	none	`v0.4.0`
@red-hat-developer-hub/backstage-plugin-quickstart	workspaces/quickstart/plugins/quickstart	none	`v1.6.2`

ciiay · 2025-09-17T05:33:31Z

/retest

jrichter1 · 2025-09-17T10:14:44Z

The tests are getting stuck when running a template. Instead of showing the run summary it ends up on a 404 page

This doesn't seem to happen on main, we tried #1460. I'm guessing it's the new dependencies somehow messing up backstage for the tests.

karthikjeeyar · 2025-09-17T15:48:20Z

scripts/i18n-scripts/generate-json.sh

+# --- Helper functions from original script -----------------------------------
+source_ts_files() {
+  local repo_dir="$1"
+  find "$repo_dir" -path "*/src/translations/ref.ts" -type f


In this rhdh-plugins repo four plugins uses ref.tsand lightspeed plugin uses translationRef, since we own this repo we can rename that file to ref.ts in lightspeed plugin but in backstageconsistently usestranslation.ts as the filename and community-plugins may have different naming as well (especially this is contributed from the community), we need to come up with a strategy to cover all the scenarios to avoid missing some plugins.

ciiay · 2025-09-18T02:58:26Z

workspaces/adoption-insights/packages/backend/package.json

Hi @jrichter1 @HusneShabbir , I have verified when I remove changes in this file the e2e tests will pass. But when I remove these two dependencies, I got another CI failure as following

✘ https://google.com/#q=%40backstage%2Fno-undeclared-imports @backstage/backend-plugin-api must be declared in dependencies of packages/backend/package.json, run 'yarn --cwd packages/backend add @backstage/backend-plugin-api' from the project root src/extensions/PermissionPolicyExtension.ts:16:1 14 | * limitations under the License. 15 | */ > 16 | import { createBackendModule } from '@backstage/backend-plugin-api'; | ^ 17 | import { 18 | PolicyDecision, 19 | isPermission, ✘ https://google.com/#q=%40backstage%2Fno-undeclared-imports @backstage/plugin-scaffolder-backend-module-github must be declared in dependencies of packages/backend/package.json, run 'yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-github' from the project root src/index.ts:24:13 22 | backend.add(import('@backstage/plugin-proxy-backend')); 23 | backend.add(import('@backstage/plugin-scaffolder-backend')); > 24 | backend.add(import('@backstage/plugin-scaffolder-backend-module-github')); | ^ 25 | backend.add(import('@backstage/plugin-techdocs-backend')); 26 | 27 | // auth plugin ✘ 2 problems (2 errors, 0 warnings)

When the PermissionPolicyExtension.ts got introduced, there were these two dependencies in the backend package.json, and the PR got merged. But now these two dependencies got removed from the package.json somehow and that's why it won't fail the e2e tests in main branch. Not sure why the PR didn't get the lint error when removing these two dependencies required in PermissionPolicyExtension.ts.

@karthikjeeyar I see you added this PermissionPolicyExtension.ts, do you see a workaround to avoid both ci failures?

Try removing the typescript dependancy in the root level package.json or match it with the typescript version used elsewhere in the project to see if that fixes this issue.

I've found that if you simply add all the mentioned dependencies, everything works fine. The moment you do a yarn dedupe, the problem starts to appear. In other words, it's the yarn.lock file, rather than the new dependencies causing this. Essentially, the choice is which CI check is going to fail (tests or the lockfile check).

Now the question is, will this have any implications outside just running this plugin using yarn start?
If not, then the tests don't even need to wait for the template result screen, as long as the insights event triggers.

karthikjeeyar · 2025-09-18T07:31:09Z

package.json

    "prettier": "^3.4.2",
-    "semver": "^7.7.2"
+    "semver": "^7.7.2",
+    "typescript": "^5.9.2"


I doubt if this mismatched typescript version in the root level is causing some ci failures in this PR, in main-branch there no e2e-tests and lint errors are observed.

github-actions · 2025-10-16T06:09:22Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

Signed-off-by: Yi Cai <[email protected]>

sonarqubecloud · 2025-10-22T17:19:32Z

Quality Gate failed

Failed conditions
6.5% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

ciiay requested review from a team, Eswaraiahsapram, JessicaJHee, divyanshiGupta, karthikjeeyar, kim-tsao and rohitkrai03 as code owners September 15, 2025 22:26

ciiay mentioned this pull request Sep 15, 2025

feat(i18n): added scripts to upload i18n files to Phrase TMS redhat-developer/rhdh#3353

Closed

5 tasks

ciiay closed this Sep 17, 2025

ciiay reopened this Sep 17, 2025

HusneShabbir mentioned this pull request Sep 17, 2025

test insights - CI test #1460

Closed

3 tasks

karthikjeeyar reviewed Sep 17, 2025

View reviewed changes

ciiay force-pushed the rhidp-8763-add-i18n-scripts branch 2 times, most recently from 3d70a1f to aaaf49c Compare September 18, 2025 01:33

ciiay commented Sep 18, 2025

View reviewed changes

karthikjeeyar reviewed Sep 18, 2025

View reviewed changes

ciiay requested review from Lucifergene, gabemontero, its-mitesh-kumar and johnmcollier as code owners September 25, 2025 19:29

ciiay force-pushed the rhidp-8763-add-i18n-scripts branch 2 times, most recently from 65f5c59 to 96617ca Compare September 30, 2025 20:03

ciiay requested review from a team, christoph-jerolimov, debsmita1 and rm3l as code owners October 2, 2025 02:18

ciiay force-pushed the rhidp-8763-add-i18n-scripts branch from 664e527 to dfefb7b Compare October 2, 2025 03:39

github-actions bot added the stale label Oct 16, 2025

ciiay added 15 commits October 22, 2025 13:07

feat(i18n): added scripts for i18n and more

09ee9d0

Signed-off-by: Yi Cai <[email protected]>

fix ci check

9c25304

Signed-off-by: Yi Cai <[email protected]>

added e2e test script

2e8aaf7

Signed-off-by: Yi Cai <[email protected]>

revert dependency update in adoption-insights

970907a

Signed-off-by: Yi Cai <[email protected]>

revert report.api.md

d4e17f7

Signed-off-by: Yi Cai <[email protected]>

fixed lint issue

6713c73

Signed-off-by: Yi Cai <[email protected]>

updated yarn.lock

6c4ad33

Signed-off-by: Yi Cai <[email protected]>

added report.api.md

a394c55

Signed-off-by: Yi Cai <[email protected]>

addressed review comments and synced translation for 3 plugins

c0a0a5d

Signed-off-by: Yi Cai <[email protected]>

updated adoption-insights/yarn.lock

b27e1f9

Signed-off-by: Yi Cai <[email protected]>

fixed script bug

73b6266

Signed-off-by: Yi Cai <[email protected]>

redeployed and resynced fr translation

ed43bee

Signed-off-by: Yi Cai <[email protected]>

scripts cleanup

dc52385

Signed-off-by: Yi Cai <[email protected]>

updated scripts and deployed translations

5f511aa

Signed-off-by: Yi Cai <[email protected]>

updated scripts

d2d416b

Signed-off-by: Yi Cai <[email protected]>

ciiay force-pushed the rhidp-8763-add-i18n-scripts branch from dfefb7b to d2d416b Compare October 22, 2025 17:18

github-actions bot removed the stale label Oct 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(i18n): added scripts for i18n and more #1448

feat(i18n): added scripts for i18n and more #1448

ciiay commented Sep 15, 2025 •

edited

Loading

Uh oh!

rhdh-gh-app bot commented Sep 15, 2025 •

edited

Loading

Uh oh!

ciiay commented Sep 17, 2025

Uh oh!

jrichter1 commented Sep 17, 2025

Uh oh!

karthikjeeyar Sep 17, 2025

Uh oh!

ciiay Sep 18, 2025

Uh oh!

karthikjeeyar Sep 18, 2025 •

edited

Loading

Uh oh!

jrichter1 Sep 18, 2025

Uh oh!

karthikjeeyar Sep 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 16, 2025

Uh oh!

sonarqubecloud bot commented Oct 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat(i18n): added scripts for i18n and more #1448

Are you sure you want to change the base?

feat(i18n): added scripts for i18n and more #1448

Conversation

ciiay commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Hey, I just made a Pull Request!

PR Summary: I18n Scripts Enhancement and Translation Sync Fix

✔️ Checklist

Testing Guide: I18n Scripts Workflow

Prerequisites

Quick Test Steps

1. Generate and upload JSON files

2. Download and sync translations

3. Verify quality

4. Test cleanup

5. Verify app runs

Success Criteria

Key Fixes Validated

Uh oh!

rhdh-gh-app bot commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Missing Changesets

Changed Packages

Uh oh!

ciiay commented Sep 17, 2025

Uh oh!

jrichter1 commented Sep 17, 2025

Uh oh!

karthikjeeyar Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

ciiay Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

karthikjeeyar Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrichter1 Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

karthikjeeyar Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 16, 2025

Uh oh!

sonarqubecloud bot commented Oct 22, 2025

Quality Gate failed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ciiay commented Sep 15, 2025 •

edited

Loading

rhdh-gh-app bot commented Sep 15, 2025 •

edited

Loading

karthikjeeyar Sep 18, 2025 •

edited

Loading

karthikjeeyar Sep 18, 2025 •

edited

Loading