GitHub Integration

Integration with GitHub makes source and translation files synchronized with GitHub repository and Crowdin translation project. All translated and approved files will be automatically pushed as a pull request to the l10n branch in GitHub repository.

Connecting GitHub with Crowdin

First, open Project Settings, Integrations tab in Crowdin. Then you have two options. You can either use your GitHub Account or GitHub Enterprise Account integration.

To integrate via your GitHub Account you can click Set Up Integration and then authorize the connection with Crowdin on the GitHub side:

In case the repository you need is private, and you have limited or no access to it, please ask the repository owner to provide you with the Access Token. Afterward, insert the token into the Token field and click Set Up Integration.

To integrate via GitHub Enterprise Account you should create an access token. Make sure to select all the required scopes:

  • Access to your public repositories or full control of private repositories(depending on the type of repository you wish to translate)
  • Full control of repository hooks(so you could get some new files or changes in the old ones translated as well)
  • Update all user data

Then insert your access token and Base URL into corresponding fields. Click Set Up Integration to proceed.

After successful integration, a pop-up dialogue would appear on your Project Settings, Integrations tab in Crowdin. In the newly appeared pop-up, continue the process of integration setup selecting necessary repository and branches that should be translated.

It is recommended to switch the duplicated strings handling to the Show (Recommended for versions) setting, so equal strings will be hidden across the branches.

Service Branches

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

By default, l10n_ is added to the created service branch name. If necessary it can be easily changed.

Branches to Sync Automatically

When you set up the integration you select existing repository branches that should be added to the Crowdin project. To add future branches from GitHub to Crowdin automatically, create a pattern for the branch names. If a branch name follows a certain pattern, it will be automatically added to Crowdin.

For example, you add a pattern *feature in the GitHub integration settings. In this case, the future branches that contain this word at the end of the title will be added to the project.

To add a pattern for branch names, follow these steps:

  1. Click Edit in the GitHub integration section.
  2. In the pop-up dialogue click Show Advanced Settings in the bottom left corner.
  3. In the Branches to Sync Automatically field, use wildcard selectors such as ‘*’, ‘?’, ‘[set]’, ‘' and others to identify the necessary branches.
  4. Click Save.

Selecting Content for Synchronization

To get the integration working, you have to specify which source files should be translated and how Crowdin should structure translated files in your repository. In case, you see a red icon with an exclamatory mark next to the service branch name, this means that you didn’t choose content for synchronization.

There are two ways to do that: configuring online or manually by creating a configuration file.

Configuring Online

This procedure is the same for all integrations with version control systems (VCS). Check VCS Integrations: Configuring Online to get to know how to select content for synchronization online.

Creating Configuration File

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

It should have the same structure as required for Synchronization Tool, but your project’s credentials should not be stored in the file’s header for the security reasons. Read more about creating a configuration file.

Synchronization Schedule

To configure the synchronization schedule – click Edit and choose the update interval.

github sync time

Checking the Status of Synchronization

Once the integration is set up, all the related information is stored in the same place – Project Settings, Integrations tab, GitHub section.
By default, synchronization is processed every 10 minutes automatically. If there’s a need to launch it instantly – click Sync Now.

github sync now

See Also

Was this article helpful?