GitHub Crowdin Action дозволяє легко інтегрувати локалізацію вашого проекту Crowdin у спеціалізований робочий процес сховища за допомогою GitHub Action. За допомогою GitHub Crowdin Action ви можете автоматизувати синхронізацію ресурсів локалізації з вашим проектом Crowdin.
Що робить ця дія?
Налаштування робочого процесу в .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. Якщо ви не хочете завантажувати джерела в Crowdin, просто встановіть для параметра upload_sources значення false.
Заздалегідь визначені джерела та переклади будуть завантажені у кореневий каталог вашого проекту Crowdin. Якщо ви все ще використовуєте гілки, ви можете вказати вихідну гілку.
Ви також можете вказати, до якої галузі GitHub ви хочете завантажити свої переклади (галузь перекладів за замовчуванням — l10n_crowdin_action).
Якщо ви не хочете завантажувати переклади з Crowdin (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 will create when opening a pull request.
# Цю гілку НЕ потрібно створювати вручну. Він буде створений автоматично під час дії.
localization_branch_name: l10n_crowdin_action
create_pull_request: true
# глобальні параметри
# Це ім'я каталогу верхнього рівня, який Crowdin буде використовувати для файлів.
# Зауважте, що це не "галузь" у сенсі git, а більше нагадує каталог верхнього рівня у вашому проекті Crowdin.
# Цю гілку НЕ потрібно створювати вручну. Він буде створений автоматично під час дії.
crowdin_branch_name: l10n_branch
identity: '/path/to/your/credentials/file'
config: '/path/to/your/crowdin.yml'
dryrun_action: true
# налаштування конфігурації
# Це цифровий ідентифікатор, який не слід плутати з рядком "project identifier" Crowdin API v1
# Подивитися "API v2" на https://uk.crowdin.com/project/<your-project>/settings#api
project_id: $
# Особистий маркер доступу, який не слід плутати з "API key" Crowdin API
# Щоб створити маркер, перейдіть до https://uk.crowdin.com/settings#api-key
token: $
source: '/path/to/your/file'
translation: 'file/export/pattern'
base_url: 'https://crowdin.com'
base_path: '/project-base-path'
Більш детальний опис цих параметрів див action.yml.
Якщо файл вашого робочого процесу містить config, вам потрібно буде додати до власного aайл конфігурації Crowdin (напр. crowdin.yml):
project_id_env: CROWDIN_PROJECT_ID
api_token_env: CROWDIN_PERSONAL_TOKEN
Коли робочий процес працює, фактичні значення вашого токена та ідентифікатора проекту будуть введені в конфігурацію, використовуючи секретні коди в оточенні.