Staging
So bereiten Sie Ihre Übersetzungen zur Überprüfung vor
Übersicht
gtx-cli stage ist ein Befehl, der Übersetzungen für Ihr Projekt erzeugt und zur Überprüfung bereitstellt.
Dieser Befehl ist nur sinnvoll, wenn Sie die manuelle Überprü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 API-Schlüssel für die Produktion! Sie erhalten ihn im Dashboard.
Der Befehl gtx-cli stage funktioniert genauso wie translate, aber anstatt die fertigen Übersetzungen herunterzuladen oder sie über das CDN (Content Delivery Network) zu veröffentlichen, werden sie lediglich zur Überprüfung bereitgestellt.
Nachdem Sie gtx-cli stage ausgeführt haben, sollten Sie gtx-cli translate ausführen, um den Vorgang abzuschließen und die Übersetzungen herunterzuladen (sofern entsprechend konfiguriert).
Nur für die Produktion!
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 außerdem daran, Ihren Produktions-API-Schlüssel (GT_API_KEY) und die Projekt-ID (GT_PROJECT_ID) als Umgebungsvariablen zu setzen.
Flags
| Parameter | Beschreibung | Typ | Optional | Standardwert |
|---|---|---|---|---|
--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 Projektstamm 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 einbeziehen | boolean | true | true |
--timeout | Zeitlimit 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 Übersetzungen für gültige Inhalte erzwingen | flag | true | false |
--dry-run | Befehl als Probelauf 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 GT_API_KEY automatisch aus, wenn diese gesetzt ist.
Es gibt einige wichtige Parameter:
| Parameter | Beschreibung |
|---|---|
--dry-run | Dieser Flag veranlasst die CLI, Ihr Projekt zu parsen und zu validieren, kommuniziert dabei jedoch nicht mit der GT-API. Das ist nützlich, um Ihre Codebasis zu überprüfen. |
--api-key | Wenn Sie nicht --dry-run verwenden, müssen Sie einen Produktions-API-Schlüssel angeben. |
--project-id | Ebenso müssen Sie, sofern Sie nicht --dry-run verwenden, eine Projekt-ID angeben. |
--new, --locales <locales> | Locales, in die Ihr Projekt übersetzt werden soll. Diese werden zu den in Ihrer gt.config.json-Datei angegebenen locales hinzugefügt. |
Konfigurationsdatei
Beim Ausführen von gtx-cli stage fügt die CLI Ihrer Datei gt.config.json automatisch die Eigenschaft stageTranslations: true hinzu.
Diese Eigenschaft stellt sicher, dass, wenn translate ausgeführt wird, ohne zuvor stage für eine bestimmte Bereitstellungsversion ausgeführt zu haben, das CLI-Tool mit einem Fehler abbricht.
Wie ist dieser Leitfaden?