GitHub-Connector

Übersicht

Diese Seite veranschaulicht, wie der GitHub Connector Inlandsdatenprojekte auf der Grundlage von Änderungen überwachen und erstellen kann, die in einer Reihe von GitHub-Repositorys auftreten.

Allgemeiner Zweck

Der GitHub Connector überwacht bestimmte Dateien in GitHub-Repositorys mit einem bestimmten Zeitintervall. In der Regel in Lokalisierungsprojekten, gemeinsame Dateien sind JSON, YML, XLIFF, XML, STRINGS oder jedes andere strukturierte und vorhersagbare Format. Wenn der Dateihash mit einem Repository zuvor ausgeführter Übersetzungen für dieselbe Datei verglichen wird, wird, wenn eine Änderung erkannt wird, ein neues Projekt erstellt und die Übersetzungsprojekte gestartet.

Überwachungsstrategien

Wir können GitHub-Repositorys mit seiner REST-API überwachen. Um dies zu tun, müssen unsere Kunden ein Konto autorisieren, um ein Token in Bureau Works zu erstellen, um auf die API zuzugreifen. Diese Anmeldeinformationen werden mit AES 256 verschlüsselt und im Profil des Clients gespeichert.

Es gibt zwei Überwachungsstrategien: Branchen und Pull-Anforderungen.

Zweige

Der Connector überwacht ständig eine oder mehrere Zweigstellen in einem oder mehreren Repositorys, und sobald die beobachteten Dateien geändert wurden, erstellt er ein Projekt in Bureau Works und benachrichtigt unser Team. Bei kontinuierlichen Lokalisierungsprojekten werden alle zuvor übersetzten Zeichenfolgen vollständig berücksichtigt.

Sobald ein Projekt bereitgestellt wurde, erstellt der GitHub Connector eine Pull-Anforderung für einen Patch-Zweig, der die Datei(en) enthält, nachdem die Übersetzung abgeschlossen ist. Wir können den Ausgabepfad und die Benennungsstrategien für die Ausgabedateien anpassen. Dies schafft einen nicht-aufdringlichen und sehr eleganten Liefermechanismus, wenn ein Team dazu neigt, einen oder nur wenige Zweige für die Entwicklung zu verwenden.

Pull-Anforderungen

Genau wie die Branch-Strategie können wir auch Pull-Anfragen überwachen, für Teams, die Gitflow oder ähnliche Workflows verwenden. Der Connector kann alle Pull-Anforderungen für alle Zweigstellen auf dieselben konfigurierten Dateien überwachen. Sobald ein Unterschied gefunden wird, der auf dem Hash der Datei basiert, wird ein Projekt erstellt.

Der große Unterschied zu dieser Strategie ist der Liefermechanismus. Da Pullanforderungen auf einen Zweig verweisen, erstellt der Connector nach der Lieferung eines Projekts einen Commit in derselben Verzweigung wie die Pullanforderung. Sobald die Pull-Anforderung akzeptiert und zusammengeführt wurde, wird sie die übersetzten Dateien auf den Zielzweig, d. h. Master, Develop usw., mitsicht.

Autorisieren von Büroarbeiten

Um den GitHub Connector einzurichten, müssen Sie zunächst Bureau Works für den Zugriff auf Ihre Repositorys autorisieren. Als zusätzliche Sicherheitsebene wird empfohlen, einen Benutzer zu erstellen, der exklusiven Zugriff auf die Repositorys hat, die für Ihre Organisation von Interesse sind.

Wenn der GitHub-Autorisierungsworkflow nicht angezeigt wird, sind möglicherweise nicht die entsprechenden Rollen auf Ihr Konto angewendet. Bitte wenden Sie sich an Ihren Organisationskontakt, oder wenn diese Person Sie ist, senden Sie uns bitte eine E-Mail an [email protected].

1. Öffnen Sie Mein Konto in der oberen rechten Ecke Ihrer Bureau Works-Ansicht.

2. Wählen Sie in der oberen Leiste GitHub verbinden aus.

3. Melden Sie sich bei GitHub mit dem Konto an, das Sie mit Bureau Works verbinden möchten.

4. GitHub sendet Sie zurück zu Bureau Works und zeigt eine Meldung an, wenn die Authentifizierung erfolgreich ist.

Bereitstellung von Überwachungs- und Lieferpfaden

Sobald Sie Bureau Works autorisieren, müssen Sie uns Pfade von Dateien und Repositorys zur Verfügung stellen, die überwacht werden müssen. In iOS-Projekten ist es beispielsweise üblich, dass eine Datei mit dem Namen Localizable.strings in jedem Sprachordner bereitgestellt wird, z. B.:

de.lproj/Localizable.strings - Quelle
pt-BR.lproj/Localizable.strings - Target A
de.lproj/Localizable.strings - Ziel B
...

Wir müssen ermitteln, welche die Quelldateien sind und welche Pfade die Übersetzungen liefern sollen. Jede Vom GitHub-Connector durchgeführte Übermittlung platziert die Dateien in Abhängigkeit von der ausgewählten Strategie in der richtigen Ordnerstruktur im GitHub-Repository.

Dieser Schritt wird von unserem Team durchgeführt und über unsere Unterstützung bei [email protected]verwaltet.

Sicherheit und Datenschutz

Jede GitHub Connector-Instanz ist Client-exklusiv, wird in einem separaten Container ausgeführt und kann nur auf das GitHub-Token zugreifen, das an das Clientprofil in Bureau Works gebunden ist. Sobald ein Token erstellt wurde, gewährt es Bureau Works Acce/Zooss an öffentliche und private Repositorys innerhalb dieser Organisation, um Pull-Anforderungen und Commits ordnungsgemäß zu erstellen.

Unser Team hat keinen Zugriff auf das verschlüsselte Token, und daher können wir nicht über API auf die Repositorys zugreifen. Wir stellen bei Bedarf einen detaillierten Audit-Trail für die Verwendung bereit, und das GitHub-System verfolgt auch die Tokenverwendung.