GitHub Crowdin Action

The GitHub Crowdin Action allows you to easily integrate the localization of your Crowdin Enterprise project into the workflow you’ve set up on your repo with help of GitHub Actions. Using GitHub Crowdin Action, you can automate the synchronization of localization resources with your Crowdin Enterprise project.

With this action you can do the following things:

  • Upload sources to Crowdin Enterprise.
  • Upload translations to Crowdin Enterprise.
  • Download translations from Crowdin Enterprise.

Використання

Налаштування робочого процесу в .github/workflows/crowdin.yml (або додати завдання до існуючих робочих процесів).

Для отримання додаткової інформації про те, як створити та налаштувати власні робочі процеси, див. Налаштування робочих процесів.

name: Crowdin Action

on:
  push:
    branches: [ master ]

jobs:
  synchronize-with-crowdin:
    runs-on: ubuntu-latest

    steps:

    - name: Checkout
      uses: actions/checkout@v2

    - name: crowdin action
      uses: crowdin/github-action@1.0.4
      with:
        upload_translations: true
        download_translations: true
      env:
        GITHUB_TOKEN: $
        CROWDIN_PROJECT_ID: $
        CROWDIN_PERSONAL_TOKEN: $

Підтримувані налаштування

Дія за замовчуванням - це завантаження джерел. Хоча ви можете встановити різні дії за допомогою параметрів with. If you don’t want to upload your sources to Crowdin Enterprise, just set the upload_sources option to false.

Заздалегідь визначені джерела та переклади будуть завантажені у кореневий каталог вашого проекту Crowdin. Якщо ви все ще використовуєте гілки, ви можете вказати вихідну гілку.

Ви також можете вказати, до якої галузі GitHub ви хочете завантажити свої переклади (галузь перекладів за замовчуванням — l10n_crowdin_action).

Якщо ви не хочете завантажувати переклади з Crowdin Enterprise (download_translations: false), параметри localization_branch_name і create_pull_request також необов’язково.

- name: crowdin action
  with:
    # upload options
    upload_sources: true
    upload_translations: true

    # download options
    download_translations: true
    language: 'uk'
    push_translations: true

    # This is the name of the git branch that Crowdin Enterprise will create when opening a pull request. 
    # Цю гілку НЕ потрібно створювати вручну. Він буде створений автоматично під час дії.
    localization_branch_name: l10n_crowdin_action
    create_pull_request: true

    # глобальні параметри

    # Це ім'я каталогу верхнього рівня, який Crowdin Enterprise буде використовувати для файлів.
    # Зауважте, що це не "галузь" у сенсі git, а більше нагадує каталог верхнього рівня у вашому проекті Crowdin.
    # Цю гілку НЕ потрібно створювати вручну. Він буде створений автоматично під час дії.
    crowdin_branch_name: l10n_branch
    identity: '/path/to/your/credentials/file'
    config: '/path/to/your/crowdin.yml'
    dryrun_action: true

    # config options

    # This is a project numeric id
    # Open a project and see "Crowdin API" at Resources > Integrations & API
    project_id: $ 

    # This is a personal access token
    # Open a project and see "Crowdin API" at Resources > Integrations & API > Create Token
    token: $
    source: '/path/to/your/file'
    translation: 'file/export/pattern'
    base_url: 'https://crowdin.com'
    base_path: '/project-base-path'

Більш детальний опис цих параметрів див action.yml.

Файл конфігурації Crowdin

If your workflow file contains the config property, you’ll need to add the following to your Crowdin Enterprise configuration file (e.g. crowdin.yml):

project_id_env: CROWDIN_PROJECT_ID
api_token_env: CROWDIN_PERSONAL_TOKEN

Коли робочий процес працює, фактичні значення вашого токена та ідентифікатора проекту будуть введені в конфігурацію, використовуючи секретні коди в оточенні.

Ця стаття була корисною?