GitHub Integration (File-based)

The GitHub integration allows you to synchronize files between your GitHub repo and Crowdin Enterprise project.

Note: You will need to install the GitHub integration in your Crowdin account before you can set it up and use it.

There are two possible GitHub integration modes you can choose from:

  • Source and translation files mode – synchronize source and translation files between your GitHub repository and Crowdin Enterprise project.
  • Target file bundles mode – generate and push translation files to your GitHub repository from the Crowdin Enterprise project in the selected format. In this mode, integration pushes translation files and doesn’t sync sources from your repo. In this mode, integration pushes translation files and doesn’t sync sources from your repo.

All translated and approved files will be automatically pushed as a merge request to the l10n branch in the GitHub repository in either of the above modes.

Connettere GitHub a Crowdin Impresa

There are two possible options you can choose from. You can either use your GitHub account or GitHub Enterprise account.

Connecting GitHub Account

  1. Open your project and go to Integrations.
  2. Clicca su GitHub nell’elenco di Integrazioni.
  3. Click Set Up Integration and select Source and translation files mode or Target file bundles mode from the drop-down list to integrate via your GitHub account.
  4. Poi autorizza la connessione con Crowdin Impresa sul lato di GitHub.

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.

Connecting GitHub Enterprise Account

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

    • repo – Full control of private repositories
    • admin:repo_hook – Full control of repository hooks
  2. Clicca su GitHub Enterprise nell’elenco delle integrazioni.
  3. Then insert your access token and Base URL into corresponding fields.
  4. Click Set Up Integration and select Source and translation files mode or Target file bundles mode from the drop-down list to proceed.

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.

Leggi di più sulle Stringhe Duplicate.

When working with GitHub integration in the Target File Bundles Mode, the integration will send the completed translations from your Crowdin Enterprise project without pulling sources from your repo. So when selecting a repository and branches that should be translated, you specify where the integration should put the generated bundles with translations.

Read more about configuring target file bundles for VCS integration.

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

Leggi di più sugli Indirizzi IP.

Rami Servizio

Quando le traduzioni sono terminate e le tue lingue sono pronte ad andare live, Crowdin Impresa invia la richiesta d’unione con le traduzioni al tuo sistema di controllo della versione. Per ogni ramo sotto localizzazione, Crowdin Imprese crea un ramo aggiuntivo del servizio con le traduzioni. 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.

Synchronization Settings

To import existing translations from your repo, select one of the following options:

  • One-time translation import after the branch is connected
  • Always import new translations from the repository

By default, the first option is selected to import translations only once. Alternatively, you can clear both options if you don’t want to import translations from your repo.

By default, sources are not pushed to the repo with translations. Although, if you perform a source text review 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.

There are cases when it’s necessary to disable translations from being pushed to the repo temporarily. In this situation, click Edit, clear Sync Schedule in the integration settings, and click Save. When ready to sync translations with the repo, select the Sync Schedule, 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.

Indipendentemente dalle impostazioni di sincronizzazione i cambiamenti dei file di origine sul repo saranno ancora sincronizzati con Crowdin Enterprise continuamente.

Rami da Sincronizzare Automaticamente

Quando si imposta l’integrazione, si selezionano i rami di repository esistenti da aggiungere al progetto Crowdin Enterprise. Quando si imposta l’integrazione, si selezionano i rami di repository esistenti da aggiungere al progetto Crowdin Enterprise.

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 appeared dialog, scroll down to the Branches to Sync Automatically.
  3. In the Branches to Sync Automatically field, use wildcard selectors such as ‘*’, ‘?’, ‘[set]’, ‘' and others to identify the necessary branches.
  4. Click Save.

Default Configuration File Name

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.

Selezionare Contenuto per la Sincronizzazione

Per far funzionare l’integrazione devi specificare quali file sorgente devono essere tradotti e come Crowdin Enterprise dovrebbe strutturare i file tradotti nel tuo 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.

Configurare Online

This procedure is the same for all integrations with version control systems (VCS). Controlla Integrazioni VCS: configurazione online per sapere come selezionare i contenuti per la sincronizzazione online.

Creare File Configurazione

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.

Leggi di più sulla creazione di un file di configurazione.

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 project and go to Integrations.
  2. Clicca su GitHub nell’elenco di Integrazioni.
  3. Click Add Repository.
  4. Configure the integration with the new repository according to your needs and preferences.

Controllare lo Stato di Sincronizzazione

Once the integration is set up, all the related information is stored in the Integrations > GitHub section.

After the integration is connected, the settings can be updated only by the project member who configured it. Tutti i gestori del progetto - eccetto la persona che ha configurato l’integrazione - vedranno il pulsante Modifica disabilitato con la seguente nota passandovi sopra col mouse: Integrazione configurata da {Full Name}.

By default, synchronization is processed every hour automatically. If you need to launch the synchronization instantly – click Sync Now. Altrimenti, se devi sincronizzare solo un ramo separatamente, clicca sul ramo necessario e seleziona Sincronizza ramo.

GitHub Sync Now

Uploading Translations from Repo

Per impostazione predefinita, le traduzioni memorizzate sul repo vengono caricate su Crowdin Enterprise solo durante la prima sincronizzazione. Per caricare manualmente le traduzioni su Crowdin Enterprise, clicca su accanto al pulsante Sincronizza ora e clicca Carica traduzioni. L’integrazione caricherà le traduzioni esistenti al tuo progetto di Crowdin Imprese.

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. Riconfigura l’integrazione di GitHub nel tuo progetto di Crowdin Impresa usando le istruzioni sopra.

Q: I have an application build configured to be triggered by every commit. Poiché Crowdin invia ogni file di traduzione in una commit separata, come posso evitare build dell’applicazione non necessarie causate dagli invii da Crowdin?
A: Poiché le integrazioni di VCS su Crowdin usano l’API per inviare i file ma non Git, ogni file è inviato separatamente.

Here are a few recommendations that might help solve similar situations:

  • Use the export_languages option to skip commits from languages you’re not interested in yet. Leggi di più sul parametro Esporta lingue per le integrazioni VCS.
  • Use the [ci skip] tag in the commit messages to skip unnecessary builds. Leggi di più sul parametro Commit Message per le integrazioni VCS.
  • Configure the preferred sync interval using Sync Schedule (e.g., set the sync once in 24 hours).
  • Squash commits when merging a localization branch to keep the master branch history clean and uncluttered.

Vedi Anche

Questo articolo è stato utile?