The GitHub Action

Example:

name: 'Push your strings to EasyTranslate'

on:
  pull_request:
    types: [ labeled ]

jobs:
  download_strings:
    if: $false
    runs-on: ubuntu-latest
    name: Send strings to EasyTranslate
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          token: $ <-- This is the github access token and needs to be stored in your repo (settings -> secrets and variables -> actions)
          ref: $ <-- this needs to stay as is

      - name: Execute our action
        uses: "easytranslate-com/strings-library-github-action@v1"
        id: push_easytranslate
        with:
          easytranslate_action: 'push'
          source_language: 'en'
          source_root_folder: 'files'
          translation_file_paths: '**/strings.json'
          target_languages: 'de,ja'
          access_token: $ <-- This is the ET access token and needs to be stored in your repo (settings -> secrets and variables -> actions)
          base_api_url: 'https://api.platform.easytranslate.com'
          team_name: 'easytrranslatecom'
          string_library_id: '63d0e5b923e85e42250de2ba'
          
      - name: Show Response
        run: |
          echo $
          echo $

Remember to update the following properties with the correct information.

token: Should be set in your own environment

source_language: You need to state the source language of your text

source_root_folder: Make sure it matches your setup and needs

translation_file_paths: Make sure it matches your setup and needs

target_languages: Input the languages the strings should be translated to

access_token: Should be set in your own environment

team_name: The team identifier you are connecting to. 

string_library_id: 'easytranslate-string-library-id'

How to pull content back to GitHub

You can pull the localised content back from the string library to GitHub at any time.

When your pull request (PR) is open and labelled with pull-easytranslate-strings it will trigger the workflow to call the EasyTranslate translation action. The action will pull all strings from the given string library.

Please note this action only works if the strings are created using the push action.

Example:

name: 'Pull your strings from EasyTranslate'

on:
  pull_request:
    types: [ labeled ]

jobs:
  pull_strings_from_easytranslate:
    if: $false
    runs-on: ubuntu-latest
    name: Download strings from EasyTranslate
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          token: $
          ref: $

      - name: Checkout PR
        env:
          GITHUB_TOKEN: $
        run: gh pr checkout $

      - name: Execute our action
        uses: "easytranslate-com/strings-library-github-action@v1"
        id: pull_easytranslate
        with:
          easytranslate_action: 'pull'
          source_language: 'en'
          source_root_folder: 'resources'
          translation_file_paths: 'files/**/**json'
          target_languages: 'da,de'
          access_token: $
          base_api_url: 'https://api.platform.sandbox.easytranslate.com'
          team_name: 'x-force-deadpool'
          string_library_id: 'easytranslate-string-library-id'

      - name: Update the pull request
        if: $false
        env:
          GITHUB_TOKEN: $
        run: |
          git config user.name 'Your Name'
          git config user.email 'Your GitHub email'
          git add .
          git commit -am 'Updating strings'
          git push

Remember to update the following properties with the correct information.

token: Should be set in your own environment

source_language: You need to state the source language of your text

source_root_folder: Make sure it matches your setup and needs

translation_file_paths: Make sure it matches your setup and needs

target_languages: Input the languages the strings should be translated to

access_token: Should be set in your own environment

team_name: The team identifier you are connecting to

string_library_id: The ID for your string library

git config user.name.: Add your Github username to authorise pull requests 

git config user.email: Add your Github user email to authorise pull requests

How to download translated files

Although the GitHub action removes the need for manual up- and download of files it is possible to download the translated content as .json files as in the example below. The action will download all strings from the given string library. The files will be downloaded in i18n format.

When your pull request (PR) is open and labelled with download-easytranslate-strings it will trigger the workflow to call the EasyTranslate translation action. The action will download all the strings from the selected string library.

The files will be under the resources folder, and their file names will be based on the language code, so in the below example, 3 files will be created with the following names: en.json, de.json and da.json. Each file will contain the strings translated into the respective languages (da and de), and a file with the source (en).

The download_strings_format can be flat or nested.

If the value is flat the key names will be as string {"global.welcome": "Your Value"}. If the value is nested the key names will be as objects "{global": {"welcome": "Your Value"}}.

Example:

name: 'Download your strings from EasyTranslate'

on:
  pull_request:
    types: [ labeled ]

jobs:
  pull_strings_from_easytranslate:
    if: $false
    runs-on: ubuntu-latest
    name: Download strings from EasyTranslate
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          token: $
          ref: $

      - name: Checkout PR
        env:
          GITHUB_TOKEN: $
        run: gh pr checkout $

      - name: Execute our action
        uses: "easytranslate-com/strings-library-github-action@v1.0.1"
        id: pull_easytranslate
        with:
          easytranslate_action: 'download'
          source_language: 'en'
          source_root_folder: 'resources'
          translation_file_paths: 'files/**/**json'
          target_languages: 'da,de'
          access_token: $
          base_api_url: 'https://api.platform.sandbox.easytranslate.com'
          team_name: 'x-force-deadpool'
          string_library_id: 'easytranslate-string-library-id'
          download_strings_format: 'flat'

      - name: Update the pull request
        if: $false
        env:
          GITHUB_TOKEN: $
        run: |
          git config user.name 'Your Name'
          git config user.email 'Your GitHub email'
          git add .
          git commit -am 'Updating strings'
          git push

Remember to update the following properties with the correct information.

token: Should be set in your own environment

source_language: You need to state the source language of your text

source_root_folder: Make sure it matches your setup and needs

translation_file_paths: Make sure it matches your setup and needs

target_languages: Input the languages the strings should be translated to

access_token: Should be set in your own environment

base_api_url: 'https://api.platform.sandbox.easytranslate.com'

team_name: The team identifier you are connecting to. 

string_library_id: The ID for your string library

git config user.name.: Add your Github username to authorise download requests 

git config user.email: Add your Github user email to authorise download requests

How to start the translation automation

Whenever you add new content to your repository simply sync the content to EasyTranslate and start the translations of the new keys in the string library. You can use the filter, search and automation options in the string library to either translate all new keys or specific keys only.

For more information on how to manage the translation step on EasyTranslate please see our string library documentation HERE.

Where to review your translations

We do not recommend making any changes directly in GitHub. If you wish to review and change any of the translations we strongly recommend you exclusively work in the internal review editor which you can access individually for each of your projects in your EasyTranslate account. Making the changes in the editor is the only way to implement the updates automatically across all relevant features. The amended translations are added automatically to your translation memory and glossary entries can be updated while editing. On top of that the string library gets updated which enables you to synchronise the updated translations back to GitHub. Finally, it ensures that your HumanAI models continuously learn from your input and preferences. You can find more info on how to access and use the internal review editor HERE.