Étape
Comment préparer vos traductions pour révision
Aperçu
gtx-cli stage est une commande qui génère des traductions pour votre projet et les met en attente pour révision.
Cette commande n'est utile que si vous avez activé la révision humaine sur votre projet.
Actuellement, cette commande n'est prise en charge que pour les applications utilisant gt-next ou gt-react.
Utilisation
Exécutez ceci dans votre pipeline CI avant de construire votre application pour la production.
npx gtx-cli stageNote : Cette commande nécessite une clé API de production ! Obtenez-en une sur la plateforme.
La commande gtx-cli stage fonctionne de la même manière que la commande translate, mais au lieu de télécharger les traductions terminées ou de les publier sur le CDN, elle les met simplement en attente pour révision.
Après avoir exécuté gtx-cli stage, vous devriez exécuter gtx-cli translate pour terminer le processus et télécharger les traductions (si configuré pour le faire).
Pour Utilisation en Production Uniquement !
Cette commande est destinée aux builds de production et ne doit pas être utilisée en développement.
Avant d'exécuter cette commande, veuillez vous assurer que vous êtes sur la branche qui sera utilisée pour la production.
N'oubliez pas de spécifier également votre clé API de production (GT_API_KEY) et l'ID de projet (GT_PROJECT_ID) dans vos variables d'environnement.
Flags
| Paramètre | Description | Type | Optionnel | Défaut |
|---|---|---|---|---|
--api-key | Spécifier une clé API de production | string | true | |
--project-id | Spécifier l'ID du projet | string | true | |
--version-id | Spécifier un ID de version (par défaut, un hash du contenu) | string | true | |
--config <path> | Spécifier un chemin vers le fichier de configuration GT | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Spécifier un chemin vers le fichier de configuration TS ou JS | string | true | |
--src <paths> | Spécifier le(s) répertoire(s) source à analyser | [string] | true | ./src && ./app && ./pages && ./components |
--dictionary <path> | Spécifier un chemin vers le fichier dictionnaire | string | true | |
--inline | Inclure les balises <T> en ligne en plus du dictionnaire | boolean | true | true |
--timeout | Le délai d'expiration pour la requête de traduction en secondes | number | true | 600 |
--new, --locales <locales> | Locales vers lesquelles traduire votre projet | [string] | true | |
--default-locale <locale> | La locale source pour le projet | string | true | en |
--ignore-errors | Ignorer les erreurs et forcer la traduction pour le contenu valide | flag | true | false |
--dry-run | Exécuter la commande en mode test | flag | true | false |
Tous ces paramètres sont optionnels.
N'ajoutez pas votre clé API au fichier gt.config.json !
Vous devriez plutôt la définir comme variable d'environnement. Le CLI lira automatiquement GT_API_KEY si elle est définie.
Il y a quelques paramètres clés :
| Paramètre | Description |
|---|---|
--dry-run | Ce flag fera que le CLI analysera et validera votre projet, mais ne communiquera pas avec l'API GT. Ceci est utile pour valider votre base de code. |
--api-key | À moins que vous n'utilisiez --dry-run, vous devez fournir une clé API de production. |
--project-id | De même, à moins que vous n'utilisiez --dry-run, vous devez fournir un ID de projet. |
--new, --locales <locales> | Locales vers lesquelles traduire votre projet. Celles-ci seront ajoutées aux locales spécifiées dans votre fichier gt.config.json. |
Fichier de configuration
Lors de l'exécution de gtx-cli stage, le CLI ajoutera automatiquement la propriété stageTranslations : true à votre fichier gt.config.json.
Cette propriété garantit que si translate est exécuté sans avoir d'abord exécuté stage pour une version de déploiement spécifique,
l'outil CLI générera une erreur et se fermera.
De plus, cette propriété garantit que la commande translate ne dupliquera pas les traductions effectuées par la commande stage.
Comment trouvez-vous ce guide ?