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 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 access Token werden ebenfalls unterstützt und sind hauptsächlich für selbst gehostete Instanzen oder Umgebungen gedacht, in denen eine OAuth App-Installation nicht möglich ist.

Voraussetzungen

Die .phrase.yml configuration-Datei 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 access token:
- 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 Integrations nach unten zu Repo Sync und klicken Sie auf Configure.

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

Das Einstellungen-Fenster für GitHub sync wird geöffnet.
Wählen Sie ein Projekt aus der Dropdown-Liste aus.
Wählen Sie die Authentifizierung-Methode aus:
- GitHub App (recommended)
  
  Wenn die GitHub App noch nicht installiert ist, klicken Sie auf Authenticate. Die Authentifizierung wird einmalig durchgeführt und kann für mehrere Repository-Syncs wiederverwendet werden.
  
  Wenn die GitHub App bereits installiert ist, klicken Sie auf Manage installation, um die App-Installation für die Ziel-Organisation oder das User-Konto zu Abschließ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 access token mit API-Bereich an.
  
  Bei Verwendung eines persönlichen access token hängt der Repository-Zugriff von dem GitHub-User ab, der das Token erstellt hat.
- Selbstgehostete Instanz
  
  Geben Sie den selbst gehosteten GitHub API endpoint und ein persönliches Repo access token mit API-Bereich an.
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 Validate Configuration, um sicherzustellen, dass die Authentifizierung-Einstellungen und die Konfigurationsdatei korrekt sind.
Wählen Sie optional eine Import behavior-Option aus, um festzulegen, wann neue oder aktualisierte Dateien automatisch in das Projekt importieren werden.
Klicke auf Speichern.

Das Projekt ist jetzt mit dem ausgewählten GitHub Repository verbunden und wurde der 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 Konfigurationsdatei korrekt konfiguriert sind. Push-Optionen sind dieselben wie für den Uploads API Endpunkt.

Dateien importieren:

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

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

Eine Standard-Sprache muss vorhanden sein.

Hinweis

Falls beim importieren 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 Phrase Technischen Support und hängen Sie die .phrase.yml Konfigurationsdatei an die Supportanfrage an.

Dateien exportieren

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

Dateien exportieren:

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

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

Die neuesten 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

Verwenden Sie bei Problemen beim Exportieren den CLI Kunde, um die .phrase.yml Konfigurationsdatei lokal zu testen und auf Fehlermeldungen zu überprüfen.

Falls erforderlich, kontaktieren Sie den Phrase Technischen Support und hängen Sie die .phrase.yml Konfigurationsdatei an die Supportanfrage 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 Repo Syncs Seite 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 zusammenführen-Request.