GitHub (Strings)

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

Tipp

Informationen zur GitHub-Integration in Phrase TMS finden Sie unter GitHub (TMS).

Phrase Strings lässt sich in GitHub-Repositories integrieren, 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 selbst gehostete 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 Branch 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 User-Konto installiert sein, dem das Repository gehört.
- Das Repository muss in der OAuth App-Installation enthalten sein.
- Berechtigungen zum Installieren oder Autorisieren von GitHub Apps sind in der Ziel-Organisation oder dem User-Konto erforderlich.
GitHub-Zugriffstoken:
- Klassische Token
  
  Erfordert den repo-Bereich (public_repo bei Synchronisierung mit einem öffentlichen Repository)
- Feingranulare Token
  
  Erfordert 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, führen Sie diese Schritte aus, um ein Repository zu verbinden:

Scrollen Sie auf der Seite Integrationen nach unten zu Repo-Synchronisierung und klicken Sie auf Konfigurieren.

Die Seite Repo Syncs wird geöffnet.
Klicken Sie auf Add Sync/GitHub.

Das Einstellungsfenster für die GitHub-Synchronisierung wird geöffnet.
Wählen Sie ein Projekt aus der Dropdown-Liste aus.
Wählen Sie die Authentifizierungsmethode aus:
- GitHub App (empfohlen)
  
  Wenn die GitHub App noch nicht installiert ist, klicken Sie auf Authentifizierung. Die Authentifizierung wird einmalig durchgeführt und kann für mehrere Repository-Synchronisierungen wiederverwendet werden.
  
  Wenn die GitHub App bereits installiert ist, klicken Sie auf Manage installation, um die App-Installation für die Zielsprache-Organisation oder das User-Konto abzuschließen. Der Repository-Zugriff wird auf Ebene der Organisation oder des User-Kontos verwaltet und ist nicht an einen einzelnen GitHub-User gebunden.
- Persönliches Zugriffstoken
  
  Geben Sie ein persönliches Repo-Zugriff-Token mit einem API-Bereich an.
  
  Bei Verwendung eines persönlichen Zugriff-Tokens hängt der Repository-Zugriff von dem GitHub-User ab, der das Token erstellt hat.
- Selbstgehostete Instanz
  
  Geben Sie den selbst gehosteten GitHub-API-Endpunkt und ein persönliches Repo-Zugriff-Token mit einem API-Bereich an.
Wenn das Zielsprache-Repository überprüfte (signierte) Commits erfordert, sollte die Authentifizierungsmethode GitHub App verwendet werden. Commits, die mit einem persönlichen Zugriff-Token gepusht werden, sind nicht signiert, daher schlägt die Synchronisierung mit folgendem Fehler fehl: „The repository requires verified (signed) commits.“
Wählen Sie ein GitHub-Repository aus der Dropdown-Liste aus.
Wählen Sie einen Repository-Branch aus der Dropdown-Liste aus, um von dort zu importieren (push) und zu exportieren (pull). Dies ist normalerweise der Master-Branch.
Geben Sie optional einen Branch-Namen für den Pull Request an. Wenn das Feld leer bleibt, wird ein Branch mit dem Standardwert phrase-translations erstellt.
Klicken Sie auf Konfiguration validieren, um sicherzustellen, dass die Authentifizierung-Einstellungen und die Konfigurationsdatei korrekt sind.
Wählen Sie optional eine Import-Verhalten-Option aus, um festzulegen, wann neue oder aktualisierte Dateien automatisch in das Projekt importiert werden.
Klicke auf Speichern.

Das Projekt ist nun mit dem ausgewählten GitHub-Repository verbunden und zur Liste hinzugefügt.
(Optional) Klicken Sie auf das Stiftsymbol, um die Integration umzubenennen.

Dateien importieren

Stellen Sie sicher, dass die Push-Befehle innerhalb der .phrase.yml Konfiguration-Datei korrekt konfiguriert sind. Push-Optionen sind dieselben wie für den Uploads API-Endpunkt.

So importieren Sie Dateien:

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

Sprachdateien (definiert als Ausgangssprache-Einträge in der Konfigurationsdatei) werden in das Projekt importiert.

Eine Standardsprache muss vorhanden sein.

Hinweis

Bei Problemen während des Importierens verwenden Sie den CLI-Kunde, um die .phrase.yml-Konfigurationsdatei lokal zu testen und auf Fehlermeldungen zu prüfen.

Falls erforderlich, kontaktieren Sie den technischen Support von Phrase und hängen Sie die .phrase.yml-Konfigurationsdatei an die Support-Anfrage an.

Dateien exportieren

Stellen Sie sicher, dass die Pull-Befehle innerhalb der .phrase.yml Konfiguration-Datei korrekt konfiguriert sind. Pull-Optionen (z. B. include_empty_translations-Parameter) sind dieselben wie für den Sprache herunterladen API-Endpunkt.

So exportieren Sie Dateien:

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

Das Exportieren-Fenster wird angezeigt.
Geben Sie den Zielsprache-Branch im Feld PR branch an.

Die aktuellsten Dateien im Repository werden als neuer Pull Request in den gewünschten Branch exportiert.
Sobald die Dateien exportiert wurden, kann der Pull Request im Repository zusammengeführt oder geschlossen und der Branch gelöscht werden.

Hinweis

Falls beim Exportieren Probleme auftreten, verwenden Sie den CLI-Kunde, um die .phrase.yml-Konfigurationsdatei lokal zu testen und auf Fehlermeldungen zu prüfen.

Falls erforderlich, kontaktieren Sie den technischen Support von Phrase und hängen Sie die .phrase.yml-Konfigurationsdatei an die Support-Anfrage an.

Verlauf

Repo-Synchronisierungen speichern einen Verlauf der letzten Importe und Exporte für jedes Phrase Strings-Projekt.

So zeigen Sie den Verlauf an:

Wählen Sie auf der Seite Repo Syncs ein Projekt aus und klicken Sie auf History <3>.

Der Import- und Exportverlauf für das Projekt wird angezeigt. Export-Einträge im Verlauf enthalten einen Link zum entsprechenden Merge Request.