GitHub-Einbindung

Die GitHub-Integration ermöglicht es dir, Dateien zwischen deinem GitHub-Repository und deinem Crowdin-Projekt zu synchronisieren.

Hinweis

Du musst die GitHub-Integration in deinem Crowdin-Konto installieren, bevor du sie einrichten und verwenden kannst.

In file-based projects, 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 project.
• Target File Bundles Mode – Übersetzungsdateien im ausgewählten Format aus dem Crowdin-Projekt generieren und in dein GitHub-Repository übertragen. In diesem Modus überträgt die Integration Übersetzungsdateien und synchronisiert keine Quellen aus deinem Repository. In this mode, integration pushes translation files and doesn’t sync sources from your repo.

In string-based projects, GitHub integration exclusively operates in the Target file bundles mode.

Mehr über Projekttypen erfahren.

All translated and approved files (or target file bundles) are automatically merged into the l10n branch of the GitHub repository.

Try GitHub Action!

An alternative to using this integration is the official Crowdin Github Action, which allows you to more flexibly configure workflows and fully control security and access to the repo, since you do not need to authorize a Github account in third-party services.

Connecting GitHub Account

1. Öffne dein Projekt und gehe zum Tab Integrationen.
2. Click on GitHub in the Integrations list.
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.

   Hinweis

   Bei stringbasierten Projekten funktioniert die GitHub-Integration ausschließlich im Modus Ziel-Dateibundles.
4. 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 an Access Token. Klicke anschließend auf Persönliches Zugriffstoken verwenden, füge das Token in das Feld Token ein und klicke auf Integration einrichten.

Berechtigungen

When setting up an integration with an access token, ensure that you have the admin level permission to the necessary repo.

Repository auswählen

Wähle im angezeigten Dialogfeld dein Repository und die zu übersetzenden Branches aus.

File-based project

Es wird empfohlen, „Doppelte Strings“ auf In einem Versions-Branch anzeigen umzuschalten, damit identische Strings zwischen Branches ausgeblendet werden. Wenn deine Quelldateien Strings mit offensichtlichen Bezeichnern (Schlüsseln) enthalten, ist es besser, eine strikte Variante dieser Option zu verwenden. In anderen Fällen kannst du gerne die reguläre Variante verwenden.

String-based project

Doppelte Strings

Version Management

Bei der Arbeit mit der GitHub-Integration im Modus Ziel-Dateibundles sendet die Integration die abgeschlossenen Übersetzungen aus deinem Crowdin-Projekt, ohne Quelldateien aus deinem Repository abzurufen. Wenn du also ein Repository und Branches auswählst, die übersetzt werden sollen, legst du fest, wohin die Integration die generierten Bundles mit den Übersetzungen ablegen soll.

Mehr über die Konfiguration von Ziel-Dateibundles für VCS-Integrationen erfahren.

Wenn Sie mit privaten Integrationen arbeiten (z. B. Integrationen mit selbst gehostetem VCS), müssen Sie dedizierte Crowdin-IP-Adressen in die Erlaubnisliste aufnehmen, um sicherzustellen, dass die Integration ordnungsgemäß funktioniert und sicher bleibt.

Mehr über IP-Adressen erfahren.

Service-Branches

Wenn die Übersetzungen fertig sind und deine Sprachen bereit zur Veröffentlichung sind, sendet Crowdin den Pull Request mit den Übersetzungen an dein Versionskontrollsystem. Für jeden zu lokalisierenden Branch erstellt Crowdin einen zusätzlichen Service-Branch mit den Übersetzungen. Wir committen nicht direkt in den Master-Branch, damit du die Übersetzungen zuerst überprüfen kannst.

Standardmäßig wird l10n_ dem Namen des erstellten Service-Branchs vorangestellt. Falls erforderlich, kannst du dies problemlos ändern.

Tipp

Wir empfehlen, den l10n_-Branch nach dem Zusammenführen des Pull Requests aus deinem Repository zu löschen, um mögliche Konflikte zu vermeiden. Crowdin erstellt den Service-Branch automatisch neu, sobald neue Übersetzungen zur Synchronisierung bereit sind.

Synchronisierungseinstellungen

Konfiguriere die Synchronisierungseinstellungen entsprechend deinen Anforderungen und Präferenzen.

Limitations

Die Optionen Vorhandene Übersetzungen importieren und Quellen übertragen sind nur für dateibasierte Projekte verfügbar.

Vorhandene Übersetzungen importieren

Um vorhandene Übersetzungen aus deinem Repository zu importieren, wähle eine der folgenden Optionen:

• Einmaliger Übersetzungsimport nach dem Verbinden des Branchs
• Neue Übersetzungen aus dem Repository immer importieren

Standardmäßig ist die erste Option ausgewählt, sodass Übersetzungen nur einmal importiert werden. Alternativ kannst du beide Optionen deaktivieren, wenn du keine Übersetzungen aus deinem Repository importieren möchtest.

Tipp

Wir empfehlen, vorhandene Übersetzungen aus dem Repository während der Einrichtung der Integration nur einmal zu importieren. Behandle Crowdin anschließend als maßgebliche Quelle und verwalte Übersetzungen ausschließlich in Crowdin, um zu verhindern, dass nicht freigegebene Übersetzungen überschrieben werden.

Klicke auf Optionen für das Hochladen von Übersetzungen, um auf die folgenden zusätzlichen Optionen zuzugreifen:

• Zielübersetzung darf mit der Quelle übereinstimmen
• Hinzugefügte Übersetzungen freigeben

Quellen übertragen

Standardmäßig werden Quellen nicht zusammen mit den Übersetzungen in das Repository übertragen. Wenn du jedoch eine Überprüfung des Quelltexts in deinem Crowdin-Projekt durchführst und die in Crowdin vorgenommenen Änderungen an deinen Quelldateien zurück in dein Repository übertragen möchtest, klicke auf Bearbeiten, wähle in den Integrationseinstellungen Quellen übertragen aus und klicke auf Speichern.

Synchronisierungszeitplan

Die Synchronisierung wird automatisch jede Stunde durchgeführt. Falls erforderlich, kannst du das Aktualisierungsintervall in den Integrationseinstellungen ändern. Um den Synchronisierungszeitplan zu konfigurieren, klicke auf Bearbeiten, scrolle nach unten zu Synchronisierungszeitplan, lege das gewünschte Intervall fest und klicke auf Speichern.

Es gibt Fälle, in denen Übersetzungen vorübergehend nicht in das Repository übertragen werden sollen. Klicke in diesem Fall auf Bearbeiten, deaktiviere Synchronisierungszeitplan in den Integrationseinstellungen und klicke auf Speichern. Wenn du die Übersetzungen wieder mit dem Repository synchronisieren möchtest, wähle Synchronisierungszeitplan aus und klicke auf Speichern.

Unabhängig von den Synchronisierungseinstellungen werden Änderungen an den Quelldateien im Repository weiterhin kontinuierlich mit Crowdin synchronisiert.

Automatisch zu synchronisierende Branches

Beim Einrichten der Integration wählst du vorhandene Repository-Branches aus, die dem Crowdin-Projekt hinzugefügt werden sollen. Um zukünftige Branches von GitHub automatisch zu Crowdin hinzuzufügen, erstelle in den Integrationseinstellungen ein Muster für die Branchnamen.

For example, you add a pattern *feature in the GitHub integration settings. In diesem Fall werden zukünftige Branches, die dieses Wort am Ende ihres Titels enthalten, dem Projekt hinzugefügt.

Führe die folgenden Schritte aus, um ein Muster für Branch-Namen hinzuzufügen:

1. Click Edit in the GitHub integration section.
2. Scrolle im angezeigten Dialogfeld nach unten zu Automatisch zu synchronisierende Branches.
3. Verwende im Feld Automatisch zu synchronisierende Branches Platzhalter wie *, ?, [set], \ und weitere, um die benötigten Branches zu bestimmen.
4. Click Save.

Standardname der Konfigurationsdatei

crowdin.yml ist der Standarddateiname, der für automatisch synchronisierte Branches verwendet wird. Um die Standardeinstellungen zu ändern, klicke auf Bearbeiten, gib im Feld Standardname der Konfigurationsdatei in den Integrationseinstellungen den gewünschten Namen ein und klicke auf Speichern.

Wenn du keinen eigenen Namen für die Konfigurationsdatei automatisch synchronisierter Branches angibst und die Integration im Stammverzeichnis des Branchs keine Konfigurationsdatei mit dem Standardnamen crowdin.yml findet, werden diese Branches in den Integrationseinstellungen mit einem roten Symbol mit Ausrufezeichen und dem Hinweis „Nicht bereit. Konfiguration prüfen“ markiert. Konfiguration prüfen

Auswählen von Inhalten für die Synchronisierung

Damit die Integration funktioniert, musst du angeben, welche Quelldateien übersetzt werden sollen und wie Crowdin die übersetzten Dateien in deinem Repository strukturieren soll. Damit die Integration im Modus für Zieldateibundles funktioniert, musst du die benötigten Bundles auswählen, die du in dein Repository übertragen möchtest.

Tipp

Wenn neben dem Namen des Service-Branchs ein rotes Symbol mit Ausrufezeichen angezeigt wird, bedeutet dies, dass du keinen Inhalt für die Synchronisierung ausgewählt hast.

Es gibt zwei Möglichkeiten, den zu synchronisierenden Inhalt festzulegen:

• Online konfigurieren
• Manuell durch Erstellen einer Konfigurationsdatei konfigurieren

Online konfigurieren

Dieses Verfahren ist für alle Integrationen mit Versionskontrollsystemen (VCS) gleich.

Unter VCS-Integrationen online konfigurieren erfährst du, wie du den zu synchronisierenden Inhalt online auswählst.

Konfigurationsdatei erstellen

The configuration file crowdin.yml should be stored in the GitHub repository along with each separate branch that you want to translate.

Sie sollte dieselbe Struktur haben, die für die CLI erforderlich ist. Aus Sicherheitsgründen dürfen die Anmeldedaten deines Projekts jedoch nicht im Header der Datei gespeichert werden.

Mehr über das Erstellen einer Konfigurationsdatei erfahren.

Mit mehreren Repositorys in einem Projekt arbeiten

Wenn du an einem plattformübergreifenden Produkt arbeitest, das Versionen für verschiedene Betriebssysteme enthält, möchtest du möglicherweise mehrere Repositorys verbinden, die Quelldateien für die einzelnen Betriebssysteme enthalten. In diesem Fall können Lokalisierungsressourcen (z. B. TMs und Glossare) und Übersetzungen effizienter genutzt werden, wodurch sich die für die Projektlokalisierung benötigte Zeit verkürzt.

Führe die folgenden Schritte aus, um ein weiteres Repository hinzuzufügen:

1. Öffne dein Projekt und gehe zum Tab Integrationen.
2. Click on GitHub in the Integrations list.
3. Klicke auf Repository hinzufügen.
4. Konfiguriere die Integration mit dem neuen Repository entsprechend deinen Anforderungen und Präferenzen.

Überprüfe den Status der Synchronisation

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

Nach dem Verbinden der Integration können die Einstellungen nur noch von dem Projektmitglied aktualisiert werden, das sie konfiguriert hat. Alle Projektmanager außer der Person, die die Integration konfiguriert hat, sehen die Schaltfläche Bearbeiten deaktiviert. Beim Darüberfahren wird folgende Meldung angezeigt: Integration was configured by {Full Name} ({username}).

Standardmäßig wird die Synchronisierung automatisch jede Stunde durchgeführt. Wenn du die Synchronisierung sofort starten möchtest, klicke auf Jetzt synchronisieren.

Alternativ kannst du, wenn du nur einen einzelnen Branch separat synchronisieren möchtest, auf beim gewünschten Branch klicken und Branch synchronisieren auswählen.

Übersetzungen aus dem Repository hochladen

Standardmäßig werden die im Repository gespeicherten Übersetzungen nur während der ersten Synchronisierung zu Crowdin hochgeladen. Um Übersetzungen manuell zu Crowdin hochzuladen, klicke auf den Dropdown-Pfeil der Schaltfläche Jetzt synchronisieren und dann auf Übersetzungen mit Crowdin synchronisieren. Die Integration lädt vorhandene Übersetzungen in dein Crowdin-Projekt hoch.

Limitations

• Die Option Übersetzungen mit Crowdin synchronisieren ist nur für dateibasierte Projekte verfügbar.
• Verwende diese Funktion mit Vorsicht, wenn bereits eine Übersetzung läuft.
  Das manuelle Hochladen von Übersetzungen aus dem Repository kann nicht freigegebene Übersetzungen, die sich derzeit im Projekt befinden, überschreiben – ähnlich wie die Option Neue Übersetzungen aus dem Repository immer importieren.

Q&A

What should I do if my repository becomes a part of the GitHub organization?

Um die GitHub-Integration in Crowdin weiterhin zu verwenden, gehe wie folgt vor:

1. Go to Authorized OAuth Apps in your GitHub account.
2. Find Crowdin OAuth App in the list and revoke its access.
3. Richte die GitHub-Integration in deinem Crowdin-Projekt anhand der obigen Anleitung erneut ein.

Wie kann ich unnötige Anwendungs-Builds vermeiden, die durch Commits von Crowdin ausgelöst werden?

Da VCS-Integrationen in Crowdin die API zum Committen von Dateien und nicht Git verwenden, wird jede Datei separat committed.

Hier sind einige Empfehlungen, die dir bei der Lösung ähnlicher Situationen helfen können:

• Verwende die Option export_languages, um Commits von Sprachen zu überspringen, die du noch nicht benötigst. Mehr über den Parameter „Export languages“ erfahren.
• Standardmäßig wird der Tag [ci skip] zur Commit-Nachricht hinzugefügt, um unnötige Builds zu überspringen. Mehr über den Parameter „Commit Message“ erfahren.
• Konfiguriere das gewünschte Synchronisierungsintervall mithilfe von Synchronisierungszeitplan (z. B. Synchronisierung einmal alle 24 Stunden).
• Führe Commits beim Zusammenführen eines Lokalisierungs-Branchs zusammen, damit die Historie des Master-Branchs übersichtlich und sauber bleibt.