GitHub (Strings)

Inhalte werden von Phrase Language AI maschinell aus dem Englischen übersetzt.

Tipp

Für Informationen zur GitHub-Integration in Phrase TMS siehe GitHub (TMS).

Phrase Strings integriert sich mit GitHub-Repositories, um Lokalisierungsdateien zwischen Phrase und GitHub zu synchronisieren.

Standardmäßig werden Repositories über eine GitHub OAuth-App verbunden. Persönliche Zugriffstoken werden ebenfalls unterstützt und sind hauptsächlich für selbstgehostete Instanzen oder Umgebungen gedacht, in denen die Installation einer OAuth-App nicht möglich ist.

Voraussetzungen

Die .phrase.yml Konfigurationsdatei muss im Stammverzeichnis des zu überwachenden Branches vorhanden sein. Die Datei legt fest, welche Dateien aus dem Repository importiert (pull) oder exportiert (push) werden sollen.
Für das Repository ist Lese- und Schreibzugriff erforderlich.
Falsch festgelegte Konfigurationsdateien können Fehler verursachen. Stelle sicher, dass die Datei mindestens ein Push- und ein Pull-Ziel, die korrekten Dateiformate und die korrekte Einstellung des Parameters update_translations enthält.
GitHub OAuth-App:
- Die GitHub OAuth-App muss in der GitHub-Organisation oder dem Konto installiert sein, das das Repository besitzt.
- Das Repository muss in die Installation der OAuth-App einbezogen werden.
- Berechtigungen zur Installation oder Autorisierung von GitHub-Apps sind in der Zielorganisation oder dem Konto erforderlich.
GitHub-Zugriffstoken:
- Klassische Token
  
  Erfordert den Repo-Bereich (public_repo, wenn mit einem öffentlichen Repository synchronisiert wird)
- Fein abgestufte Token
  
  Benötigt die folgenden Berechtigungen:
  - Inhalte: Lesen und Schreiben
  - Pull-Requests: Lesen und Schreiben
- Stelle sicher, dass für die Repository-Einstellungen keine signierten Commits erforderlich sind.
Wenn SSO in GitHub aktiviert ist, muss es auch für das Zugriffstoken aktiviert werden.
Der Branch phrase_translations kann nicht geschützt werden.

Hinweis

Aufgrund kontinuierlicher Verbesserungen kann die Benutzeroberfläche nicht genau so aussehen wie im Video dargestellt.

Repositories verbinden

Sobald die Konfigurationsdatei vorhanden ist, um ein Repository zu verbinden, befolgen Sie diese Schritte:

Gehen Sie von der Integrationen Seite nach unten zu Repo Sync und klicken Sie auf Konfigurieren.

Die Seite Repo Syncs öffnet sich.
Klicken Sie auf Sync/GitHub hinzufügen.

Das Einstellungsfenster für die GitHub-Synchronisierung öffnet sich.
Wählen Sie ein Projekt aus der Dropdown-Liste aus.
Wählen Sie die Authentifizierungsmethode:
- GitHub-App (empfohlen)
  
  Wenn die GitHub-App noch nicht installiert ist, klicken Sie auf Authentifizieren. Die Authentifizierung erfolgt einmal und kann für mehrere Repository-Synchronisierungen wiederverwendet werden.
  
  Wenn die GitHub-App bereits installiert ist, klicken Sie auf Installation verwalten, um die App-Installation für die Zielorganisation oder das Benutzerkonto abzuschließen. Der Zugriff auf das Repository wird auf Organisationsebene oder Kontoeinstellung verwaltet und ist nicht an einen einzelnen GitHub-Benutzer gebunden.
- Persönliches Zugriffstoken
  
  Stellen Sie ein persönliches Repo-Zugriffstoken mit einem API-Bereich zur Verfügung.
  
  Bei Verwendung eines persönlichen Zugriffstokens hängt der Zugriff auf das Repository von dem GitHub-Benutzer ab, der das Token erstellt hat.
- Selbstgehostete Instanz
  
  Geben Sie den GitHub selbstgehosteten API-Endpunkt und ein persönliches Repo-Zugriffstoken mit einem API-Bereich an.
Wählen Sie ein GitHub-Repository aus der Dropdown-Liste aus.
Wählen Sie einen Branch des Repositories aus der Dropdown-Liste aus, um zu importieren (push) und zu exportieren (pull). Dies ist normalerweise der Master-Branch.
Optional können Sie einen Branch-Namen für die Pull-Anfrage angeben. Wenn das Feld leer bleibt, wird ein Branch mit dem Standardwert phrase-translations erstellt.
Klicken Sie auf Konfiguration validieren, um sicherzustellen, dass die Authentifizierungseinstellungen und die Konfigurationsdatei korrekt sind.
Wählen Sie optional eine Importverhalten-Option aus, um zu bestimmen, wann neue oder aktualisierte Dateien automatisch in das Projekt importiert werden.
Klicken Sie auf Speichern.

Das Projekt ist jetzt mit dem ausgewählten GitHub-Repository verbunden und zur Liste hinzugefügt worden.

Dateien importieren

Stellen Sie sicher, dass die Push-Befehle korrekt in der .phrase.yml Konfigurations-Datei konfiguriert sind. Die Push-Optionen sind die gleichen wie für den Uploads API-Endpunkt.

Um Dateien zu importieren:

Wählen Sie auf der Seite Repo-Synchronisierungen ein Projekt aus und klicken Sie auf Importieren .

Sprache Dateien (definiert als Push-Quelleneinträge in der Konfigurationsdatei) werden in das Projekt importiert.

Eine Standard-Sprache muss vorhanden sein.

Hinweis

Im Falle von Problemen beim Importieren verwenden Sie den CLI Client, um die .phrase.yml Konfigurationsdatei lokal zu testen und nach Fehlermeldungen zu suchen.

Falls erforderlich, kontaktieren Sie den technischen Support von Phrase und fügen Sie die .phrase.yml Konfigurationsdatei der Supportanfrage bei.

Exportdateien

Stellen Sie sicher, dass die Pull-Befehle korrekt in der .phrase.yml Konfigurations datei konfiguriert sind. Pull-Optionen (z.B. include_empty_translations Parameter) sind die gleichen wie für den locales download API-Endpunkt.

Um Dateien zu exportieren:

Wählen Sie auf der Repo Syncs Seite ein Projekt aus und klicken Sie auf Export .

Das Export Fenster wird angezeigt.
Geben Sie den Ziel-Branch im Feld PR-Branch an.

Die aktuellsten Dateien im Repository werden als neue Pull-Anfrage an den gewünschten Branch exportiert.
Sobald die Dateien exportiert sind, kann die Pull-Anfrage im Repository zusammengeführt oder geschlossen und der Branch gelöscht werden.

Hinweis

Im Falle von Problemen beim Exportieren verwenden Sie den CLI Client, um die .phrase.yml Konfigurationsdatei lokal zu testen und nach Fehlermeldungen zu suchen.

Falls erforderlich, kontaktieren Sie den technischen Support von Phrase und fügen Sie die .phrase.yml Konfigurationsdatei der Supportanfrage bei.

Historie

Repo-Synchronisierungen führen eine Historie der letzten Importe und Exporte für jedes Phrase Strings Projekt.

Um die Historie anzuzeigen:

Wählen Sie auf der Repo Syncs Seite ein Projekt aus und klicken Sie auf Historie .

Die Import- und Exporthistorie für das Projekt wird angezeigt. Exporteinträge in der Historie enthalten einen Link zur entsprechenden Zusammenführungsanfrage.