Integration with GitHub synchronizes source and translation files between your GitHub repository and translation project in Crowdin. All translated and approved files will be automatically pushed as a pull request to the l10n branch in the GitHub repository.
There are two possible options you can choose from. You can either use your GitHub account or GitHub Enterprise account.
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, click Use personal access token and 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 the required scopes:
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.
Read more about Duplicate Strings.
When you work with private integrations (e.g., integrations with self-hosted VCS), you need to add dedicated Crowdin 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 sends the pull request with translations to your version control system. For every branch that is under localization, Crowdin creates an additional service branch with translations. We don’t commit directly to the master branch so that you can verify translations first.
By default, l10n_ is added to the created service branch name. If necessary, you can easily change it.
By default, sources are not pushed to the repo with translations. Although, if you perform a source text review in your Crowdin project and would like to push the changes made to your source files on Crowdin back to your repo, click Edit, select Push Sources in the integration settings, and click Save.
There are cases when it’s necessary to disable translations from being pushed to the repo temporarily. In this situation, click Edit, clear Push Translations in the integration settings, and click Save. When ready to sync translations with the repo, select the Push Translations, and click Save.
The synchronization is processed every hour automatically. If necessary, you can change the update interval in the integration settings. To configure the synchronization schedule – click Edit, scroll down to the Sync Schedule, set the preferred interval, and click Save.
Not depending on the synchronization settings, the source files’ changes on the repo will still be synced with Crowdin every ten minutes.
When you set up the integration, you select existing repository branches to be added to the Crowdin project. To add future branches from GitHub to Crowdin automatically, create a pattern for the branch names in the integration settings.
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:
crowdin.yml is the default file name that is used for automatically synchronized branches. 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.
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. 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.
There are two ways to do that: configuring online or manually by creating a configuration file.
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.
crowdin.yml 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 CLI, but your project’s credentials should not be stored in the file’s header for security reasons.
Read more about creating a configuration file.
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:
Once the integration is set up, all the related information is stored in the same place – Settings > Integrations tab > GitHub section.
By default, synchronization is processed every hour automatically. If you need to launch the synchronization instantly – click Sync Now.
By default, the translations stored on the repo are uploaded to Crowdin during the first synchronization only. To upload translations to Crowdin manually, click on the drop-down toggle on the Sync Now button, and click Upload Translations. The integration will upload existing translations to your Crowdin project.
Q: What should I do if my repository becomes a part of the GitHub organization?
A: To continue using GitHub integration in Crowdin, follow these steps: