Staging
So stellen Sie Ihre Übersetzungen zur Prüfung bereit
Übersicht
gtx-cli stage ist ein Befehl, der Übersetzungen für Ihr Projekt generiert und zur Prüfung bereitstellt.
Dieser Befehl ist nur hilfreich, wenn Sie die manuelle Prüfung in Ihrem 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 aus, bevor Sie Ihre App für die Produktion builden.
npx gtx-cli stageHinweis: Dieser Befehl erfordert einen Produktions-API-Schlüssel! Du erhältst ihn in der Plattform.
Der Befehl gtx-cli stage funktioniert wie translate, aber anstatt die fertigen Übersetzungen herunterzuladen oder sie auf das CDN (Content Delivery Network) zu veröffentlichen, werden sie lediglich zur Überprüfung bereitgestellt.
Nachdem du gtx-cli stage ausgeführt hast, solltest du gtx-cli translate ausführen, um den Prozess abzuschließen und die Übersetzungen herunterzuladen (sofern entsprechend konfiguriert).
Nur für den Produktionseinsatz!
Dieser Befehl ist für Produktions-Builds gedacht und sollte nicht in der Entwicklung verwendet werden.
Bevor du diesen Befehl ausführst, stelle sicher, dass du auf dem Branch bist, der für die Produktion verwendet wird.
Denk daran, außerdem deinen Produktions-API-Schlüssel (GT_API_KEY) und die Projekt-ID (GT_PROJECT_ID) in deinen Umgebungsvariablen zu setzen.
Flags
| Parameter | Beschreibung | Typ | Optional | Standard |
|---|---|---|---|---|
--api-key | Produktions-API-Schlüssel angeben | string | true | |
--project-id | Projekt-ID angeben | string | true | |
--version-id | Versions-ID angeben (standardmäßig ein Hash des Inhalts) | string | true | |
--config <path> | Pfad zur GT-Konfigurationsdatei angeben | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Pfad zur TS- oder JS-Konfigurationsdatei angeben | string | true | |
--src <paths> | Durch Leerzeichen getrennte Liste von Glob-Mustern zum Auffinden von Quelldateien. Sollte relativ zum Stammverzeichnis sein. | [string] | true | [ 'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ] |
--dictionary <path> | Pfad zur Wörterbuchdatei angeben | string | true | |
--inline | Inline-<T>-Tags zusätzlich zum Wörterbuch einschließen | boolean | true | true |
--timeout | Zeitüberschreitung für die Übersetzungsanfrage in Sekunden | number | true | 600 |
--new, --locales <locales> | Locales, in die Ihr Projekt übersetzt werden soll | [string] | true | |
--default-locale <locale> | Quell-Locale für das Projekt | string | true | en |
--ignore-errors | Fehler ignorieren und Übersetzen für gültige Inhalte erzwingen | flag | true | false |
--dry-run | Befehl als Trockenlauf ausführen | flag | true | false |
Alle diese Parameter sind optional.
Fügen Sie Ihren API-Schlüssel nicht in die gt.config.json-Datei ein!
Setzen Sie ihn stattdessen als Umgebungsvariable. Die CLI liest automatisch GT_API_KEY, sofern gesetzt.
Es gibt einige zentrale Parameter:
| Parameter | Beschreibung |
|---|---|
--dry-run | Dieses Flag veranlasst die CLI, Ihr Projekt zu parsen und zu validieren, kommuniziert jedoch nicht mit der GT-API. Dies ist nützlich, um Ihre Codebasis zu validieren. |
--api-key | Sofern Sie --dry-run nicht verwenden, müssen Sie einen Produktions-API-Schlüssel angeben. |
--project-id | Ebenso müssen Sie, sofern Sie --dry-run nicht verwenden, eine Projekt-ID angeben. |
--new, --locales <locales> | Locales, in die Ihr Projekt übersetzt werden soll. Diese werden an die in Ihrer gt.config.json-Datei angegebenen Locales angehängt. |
Konfigurationsdatei
Beim Ausführen von gtx-cli stage fügt die CLI automatisch die Eigenschaft stageTranslations : true zu deiner Datei gt.config.json hinzu.
Diese Eigenschaft stellt sicher, dass, wenn translate ausgeführt wird, ohne zuvor stage für eine bestimmte Deployment-Version auszuführen, die CLI mit einem Error beendet wird.
Wie ist diese Anleitung?