Setup Crowdin

[andrii-bodnar]

Hey everyone,

It's Andrii from Crowdin. Just did some analysis of the current i18n workflow and it feels like issues and PRs reported by the community are not so easy to handle. The community translators can work together in Crowdin, translations would be delivered as PR and volunteers can raise issues for problematic strings via Crowdin.

Crowdin is free for open-source projects. This integration works in the following way:

• the action runs every 6 hours (actually, it's up to you what trigger to use, it could also be a push to the default branch, for example)
• upload new source texts to the Crowdin project
• upload existing translations to Crowdin (using the upload_translations action config parameter, it's necessary only for the first time)
• download all the new translations from Crowdin and commit these translations to the localization_branch_name
• open a Pull Request with the latest translations.

You can find my demo Crowdin project here - readme.so-demo.

Example of the first PR that will be created by Crowdin Action - PR example (Don't worry about the diffs - it's just updated the translation files to the actual state. The next PRs will include the new translations only).

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
readme-so	✅ Ready (Inspect)	Visit Preview	Oct 28, 2022 at 7:25AM (UTC)

[andrii-bodnar]

The next steps you can do to move further with this integration:

• Create a Crowdin account.
• Submit the Open-source project setup request form.
• Create a new Crowdin Project:
  • As a source language select English language.
  • Fill in other target languages.
  • In the project settings enable the global Translation Memory (optional).
• Generate a new Personal Access Token in your Crowdin account settings.
• Generate a new GitHub Token (only the repo scope is required).
• Create the Actions secrets for your repository:
  • CROWDIN_PERSONAL_TOKEN - the personal access token generated in Crowdin.
  • CROWDIN_PROJECT_ID - ID of the Crowdin project.
  • GH_TOKEN - the personal access token generated in GitHub.
• merge this PR.