LeiaInc / TranslatorBot

Github action to translate strings.xml file in Android projects and create localized string resources using Google Translate API

TranslatorBot

Latest Release - v2.0.0

A GitHub Action for automatically translating the strings.xml file in your android project using Google Cloud Translate API.

Features

• Parses the strings.xml file in the default values folder, translates strings if required using Translate API and creates the respective localized strings.xml files.
• The bot will automatically add a commit to your branch/Pull Request if strings have been translated.
• Output languages can be configured on your workflow.

Usage

This action has two required inputs.

1. An API key. If a non Leia repository, you can get your own cloud translations API key by following the instructions here .
2. Language codes of translated output languages separated by a comma
3. A comma-separated list of 1 or more Android res dirs to translate (ie, "app/src/main/res/, lib/src/main/res/")

For example, the following workflow adds the Translator action for every Pull request created to a project. The output languages are set to Spanish, French and Chinese.

You can look up the ISO-639-1 language codes specified here .

on: pull_request
name: Translations Workflow
jobs:
  formatCode:
    name: Translate Strings
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: '0'
      - name: translate strings
        uses: LeiaInc/TranslatorBot@v2.0.0
        with:
          translationKey: 'YOUR_API_KEY'
          outputLanguages: 'es,fr,zh'
          resDirectories: 'app/src/main/res/'

If using in a Leia repository, you can use the shared Translations API key The following workflow uses the Shared translations key available for all Leia Repositories.

on: pull_request
name: Translations Workflow
jobs:
  formatCode:
    name: Translate Strings
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: '0'
      - name: translate strings
        uses: LeiaInc/TranslatorBot@v2.0.0
        with:
          translationKey: ${{ secrets.GOOGLE_TRANSLATE_API_KEY }}
          outputLanguages: 'es,fr,zh'
          resDirectories: 'app/src/main/res/'

Specification

• Bot will create a new localized strings.xml file if doesn't already exist, under app/src/main/res/values-lang_code/strings.xml
• If translations already exist, they will be copied over without translating even if the default strings.xml value is changed
• If translations exists and was written by the bot, the bot will update it everytime a change is made to the original strings.xml file.
• Non-translatable xml elements won't be copied over