Stage
Wie Sie Ihre Übersetzungen zur Überprüfung bereitstellen
Übersicht
gtx-cli stage ist ein Befehl, der Übersetzungen für Ihr Projekt generiert und sie zur Überprüfung bereitstellt.
Dieser Befehl ist nur nützlich, wenn Sie die menschliche Überprüfung für Ihr Projekt aktiviert haben.
Derzeit wird dieser Befehl nur für Apps unterstützt, die gt-next oder gt-react verwenden.
Verwendung
Führen Sie dies in Ihrer CI-Pipeline vor dem Erstellen Ihrer App für die Produktion aus.
npx gtx-cli stageHinweis: Dieser Befehl erfordert einen Produktions-API-Schlüssel! Holen Sie sich einen auf der Plattform.
Der gtx-cli stage Befehl funktioniert genauso wie der translate Befehl, aber anstatt die fertigen Übersetzungen herunterzuladen oder sie im CDN zu veröffentlichen, stellt er sie einfach zur Überprüfung bereit.
Nach dem Ausführen von gtx-cli stage sollten Sie gtx-cli translate ausführen, um den Prozess abzuschließen und die Übersetzungen herunterzuladen (falls entsprechend konfiguriert).
Nur für den Produktionseinsatz!
Dieser Befehl ist für Produktions-Builds gedacht und sollte nicht in der Entwicklung verwendet werden.
Bevor Sie diesen Befehl ausführen, stellen Sie bitte sicher, dass Sie sich auf dem Branch befinden, der für die Produktion verwendet wird.
Denken Sie auch daran, Ihren Produktions-API-Schlüssel (GT_API_KEY) und die Projekt-ID (GT_PROJECT_ID) in Ihren Umgebungsvariablen anzugeben.
Flags
| Parameter | Beschreibung | Typ | Optional | Standard |
|---|---|---|---|---|
--api-key | Einen Produktions-API-Schlüssel angeben | string | true | |
--project-id | Die Projekt-ID angeben | string | true | |
--version-id | Eine Versions-ID angeben (standardmäßig ein Hash des Inhalts) | string | true | |
--config <path> | Einen Pfad zur GT-Konfigurationsdatei angeben | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Einen Pfad zur TS- oder JS-Konfigurationsdatei angeben | string | true | |
--src <paths> | Das/die zu scannende(n) Quellverzeichnis(se) angeben | [string] | true | ./src && ./app && ./pages && ./components |
--dictionary <path> | Einen Pfad zur Wörterbuchdatei angeben | string | true | |
--inline | Inline-<T>-Tags zusätzlich zum Wörterbuch einschließen | boolean | true | true |
--timeout | Das Timeout für die Übersetzungsanfrage in Sekunden | number | true | 600 |
--new, --locales <locales> | Sprachen, in die Ihr Projekt übersetzt werden soll | [string] | true | |
--default-locale <locale> | Die Quellsprache für das Projekt | string | true | en |
--ignore-errors | Fehler ignorieren und Übersetzung für gültigen Inhalt erzwingen | flag | true | false |
--dry-run | Den Befehl als Testlauf ausführen | flag | true | false |
Alle diese Parameter sind optional.
Fügen Sie Ihren API-Schlüssel nicht zur gt.config.json-Datei hinzu!
Sie sollten ihn stattdessen als Umgebungsvariable setzen. Die CLI liest automatisch GT_API_KEY, wenn es gesetzt ist.
Es gibt einige wichtige Parameter:
| Parameter | Beschreibung |
|---|---|
--dry-run | Dieses Flag bewirkt, dass die CLI Ihr Projekt parst und validiert, aber nicht mit der GT API kommuniziert. Dies ist nützlich zur Validierung Ihrer Codebasis. |
--api-key | Sofern Sie nicht --dry-run verwenden, müssen Sie einen Produktions-API-Schlüssel bereitstellen. |
--project-id | Ebenso müssen Sie, sofern Sie nicht --dry-run verwenden, eine Projekt-ID bereitstellen. |
--new, --locales <locales> | Sprachen, in die Ihr Projekt übersetzt werden soll. Diese werden an die in Ihrer gt.config.json-Datei angegebenen Sprachen angehängt. |
Konfigurationsdatei
Beim Ausführen von gtx-cli stage fügt die CLI automatisch die Eigenschaft stageTranslations : true zu Ihrer gt.config.json-Datei hinzu.
Diese Eigenschaft stellt sicher, dass wenn translate ausgeführt wird, ohne zuvor stage für eine bestimmte Deployment-Version ausgeführt zu haben,
das CLI-Tool einen Fehler ausgibt und beendet wird.
Zusätzlich stellt diese Eigenschaft sicher, dass der translate-Befehl die vom stage-Befehl durchgeführten Übersetzungen nicht dupliziert.
Wie ist dieser Leitfaden?