Skip to content

Document how to regenerate the translation files after adding a new translation key #2724

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

Open
3 tasks done
502E532E opened this issue Apr 27, 2025 · 0 comments
Open
3 tasks done
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@502E532E
Copy link

Describe the request

I created a pull request (#2718) that includes a new translation key. Although it worked on my local computer, the GitHub Actions Check for translation files (Check Internationalization / check) failed. By looking at the logs of the failed check, I found that running yarn i18n:generate resolves this. But I am still not sure if that is the correct way to resolve this (although I assume it is).

There should be a section in the docs (presumably the pull request guide) that explains how to proceed after adding a new translation key and explain the implications.

Describe the current behavior

There is no mention in the docs. The command I used is not documented anywhere in the repo.

> grep -r arduino-ide/ -e i18n:generate
arduino-ide/package.json:    "i18n:generate": "theia nls-extract -e vscode -f \"+(arduino-ide-extension|electron-app|plugins)/**/*.ts?(x)\" -o ./i18n/en.json",
arduino-ide/package.json:    "i18n:check": "yarn i18n:generate && git add -N ./i18n && git diff --exit-code ./i18n",

Arduino IDE version

2.3.7

Operating system

Linux

Operating system version

6.14.2-arch1-1

Additional context

No response

Issue checklist

  • I searched for previous requests in the issue tracker
  • I verified the feature was still missing when using the latest nightly build
  • My request contains all necessary details
@502E532E 502E532E added the type: enhancement Proposed improvement label Apr 27, 2025
@per1234 per1234 added the topic: documentation Related to documentation for the project label Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants