Інтеграція з GitHub

Integration with GitHub synchronizes source and translation files between your GitHub repository and translation project in Crowdin Enterprise. Всі перекладені і затверджені файли будуть автоматично відправлені у вигляді запиту злиття в гілку l10n сховища GitHub.

Connecting GitHub with Crowdin Enterprise

Можливі два варіанти. You can either use your GitHub account or GitHub Enterprise account.

Підключіться через обліковий запис GitHub

  1. Open your Crowdin Enterprise project and go to Applications > System.
  2. Click on GitHub in the Integrations list.
  3. Click Set Up Integration to integrate via your GitHub account.
  4. Then authorize the connection with Crowdin Enterprise on the GitHub side.

Якщо потрібне вам сховище є приватним, і ви маєте обмежений доступ до нього або не маєте його, попросіть власника сховища надати його вам токен доступу. Afterward, click Use personal access token and insert the token into the Token field and click Set Up Integration.

Підключіться через обліковий запис GitHub Enterprise

  1. To integrate via GitHub Enterprise account, you should create an access token. Обов’язково оберіть потрібні області застосування:

    • repo – Повний контроль над приватними сховищами
    • admin:repo_hook – Повний контроль над хуками сховища
  2. Click on GitHub Enterprise in the Integrations list.
  3. Потім вставте маркер доступу та основну URL-адресу у відповідні поля. Клацніть Налаштувати інтеграцію, щоб продовжити.

Selecting Repository

In the appeared dialog, select your repository and branches that should be translated. It’s recommended to switch Duplicate Strings to Show within a version branch, so identical strings will be hidden between branches. If your source files contain strings with apparent identifiers (keys), it’s better to use a strict version of this option. In other cases, feel free to use a regular one.

Детальніше про Дублікати рядків.

When you work with private integrations (e.g., integrations with self-hosted VCS), you need to add dedicated Crowdin Enterprise IP addresses to the whitelist to ensure that it operates properly while staying secure.

Read more about IP Addresses.

Службові гілки

When translations are finished and your languages are ready to go live, Crowdin Enterprise sends the pull request with translations to your version control system. For every branch that is under localization, Crowdin Enterprise creates an additional service branch with translations. We don’t commit directly to the master branch so that you can verify translations first.

Зумовлено, до імені створеної сервісної гілки додається l10n\ _. If necessary, you can easily change it.

Налаштування синхронізації

За замовчуванням джерела не надсилаються до сховища з перекладами. Although, if you perform source text changes in your Crowdin Enterprise project and would like to push the changes made to your source files on Crowdin Enterprise back to your repo, click Edit, select Push Sources in the integration settings, and click Save.

Бувають випадки, коли необхідно тимчасово відключити переклади від надсилання до сховища. In this situation, click Edit, clear Push Translations in the integration settings, and click Save. Коли ви будете готові синхронізувати переклади із сховищем, оберіть Надіслати переклади та натисніть Зберегти.

Синхронізація обробляється щогодини автоматично. If necessary, you can change the update interval in the integration settings. Щоб налаштувати графік синхронізації, натисніть Редагувати, прокрутіть до Розклад синхронізації, встановіть пріоритетний інтервал і натисніть Зберегти.

Not depending on the synchronization settings, the source files’ changes on the repo will still be synced with Crowdin Enterprise every ten minutes.

Гілки для автоматичної синхронізації

When you set up the integration, you select existing repository branches to be added to the Crowdin Enterprise project. To add future branches from GitHub to Crowdin Enterprise automatically, create a pattern for the branch names in the integration settings.

Наприклад, додайте шаблон *feature у налаштування інтеграції GitHub. В цьому випадку майбутні гілки, які містять це слово в кінці назви, будуть додані в проект.

Щоб додати шаблон для назв гілок, виконайте наступні дії:

  1. Натисніть Редагувати в розділі інтеграції GitHub.
  2. In the appeared dialog, scroll down to the Branches to Sync Automatically.
  3. В поле Гілки для автоматичної синхронізації використовуйте символи, такі як ‘*’, ‘?’, ‘[set]’, ‘' і інші, щоб визначити необхідні гілки.
  4. Натисніть Зберегти.

Ім’я файлу конфігурації за замовчуванням

crowdin.yml — це ім’я файлу за замовчуванням, яке використовується для автоматично синхронізованих гілок. To change the default settings, click Edit, specify the preferred name in the Default configuration file name field in the integration settings, and click Save.

Вибір контенту для синхронізації

Щоб забезпечити інтеграцію, ви повинні вказати, які вихідні файли повинні бути перекладені і як Crowdin Enterprise повинен структурувати перекладені файли в ваше сховище. If you see a red icon with an exclamatory mark next to the service branch name, it means that you didn’t select content for synchronization.

Є два способи зробити це: конфігурація в мережі або вручну через створення файлу конфігурації.

Налаштування Онлайн

Ця процедура однакова для інтеграцій з усіма системами контролю версій (VCS). Ознайомтеся з Інтеграції VCS: Конфігурація в мережі, щоб дізнатися про те, як вибрати вміст для синхронізації в мережі.

Створення файлу конфігурації

Configuration file crowdin.yml should be stored in the GitHub repository along with each separate branch that you want to translate, so Crowdin Enterprise knows what files exactly should be sent for translations.

It should have the same structure as required for CLI, but your project’s credentials should not be stored in the file’s header for security reasons.

Детальніше про створення файлу конфігурації.

Working with Multiple Repositories within One Project

When working with a multiplatform product that has versions for different operating systems, you might want to connect multiple repositories that contain source files for each operating system. In this case, localization resources (e.g., TMs, Glossaries) and translations could be used more efficiently, reducing the time needed for project localization.

To add another repository, follow these steps:

  1. Open your Crowdin Enterprise project and go to Applications > System.
  2. Click on GitHub in the Integrations list.
  3. Click Add Repository.
  4. Configure the integration with the new repository according to your needs and preferences.

Перевірка стану синхронізації

Once the integration is set up, all the related information is stored in the same place – Applications > System > GitHub section. By default, synchronization is processed every hour automatically. Якщо вам потрібно запустити синхронізацію миттєво, натисніть кнопку Синхронізувати.

GitHub Синхронізувати зараз

Завантаження перекладів зі сховища

By default, the translations stored on the repo are uploaded to Crowdin Enterprise during the first synchronization only. To upload translations to Crowdin Enterprise manually, click next to the Sync Now button, and click Upload Translations. The integration will upload existing translations to your Crowdin Enterprise project.

Q&A

Q: What should I do if my repository becomes a part of the GitHub organization?
A: To continue using GitHub integration in Crowdin Enterprise, follow these steps:

  1. Go to Authorized OAuth Apps in your GitHub account.
  2. Find Crowdin OAuth App in the list and revoke its access.
  3. Set up the GitHub integration in your Crowdin Enterprise project again using the instructions above.

Дивись також

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