Préproduction
Comment préparer vos traductions pour relecture
Présentation
gtx-cli stage est une commande qui génère les traductions de votre projet et les met en attente pour relecture.
Cette commande n’est utile que si vous avez activé la relecture 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 cette commande dans votre pipeline CI avant de créer votre application pour la production.
npx gtx-cli stageRemarque : Cette commande nécessite une clé d’API de production ! Obtenez-en une sur la plateforme.
La commande gtx-cli stage fonctionne de la même manière que translate, mais au lieu de télécharger les traductions finalisées ou de les publier sur le CDN (réseau de diffusion de contenu), elle les met simplement en attente pour relecture.
Après avoir exécuté gtx-cli stage, exécutez gtx-cli translate pour terminer le processus et télécharger les traductions (si configuré).
Réservé à la production !
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, assurez-vous d’être sur la branche qui sera utilisée pour la production.
N’oubliez pas non plus de définir votre clé d’API de production (GT_API_KEY) et votre ID de projet (GT_PROJECT_ID) dans vos variables d’environnement.
Options
| Paramètre | Description | Type | Optionnel | Valeur par défaut |
|---|---|---|---|---|
--api-key | Spécifie une clé d’API de production | string | true | |
--project-id | Spécifie l’ID du projet | string | true | |
--version-id | Spécifie un ID de version (par défaut, un hachage du contenu) | string | true | |
--config <path> | Spécifie le chemin du fichier de configuration GT | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Spécifie le chemin du fichier de configuration TS ou JS | string | true | |
--src <paths> | Liste d’expressions glob, séparées par des espaces, correspondant aux fichiers source. Doivent être relatives au répertoire racine. | [string] | true | [ 'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ] |
--dictionary <path> | Spécifie le chemin du fichier dictionary | string | true | |
--inline | Inclure les balises <T> en ligne en plus du dictionary | boolean | true | true |
--timeout | Délai d’attente de la requête de traduction, en secondes | number | true | 600 |
--new, --locales <locales> | Locales vers lesquelles traduire votre projet | [string] | true | |
--default-locale <locale> | Locale source du projet | string | true | en |
--ignore-errors | Ignorer les erreurs et forcer la traduction du contenu valide | flag | true | false |
--dry-run | Exécuter la commande à blanc | flag | true | false |
Tous ces paramètres sont optionnels.
N’ajoutez pas votre clé d’API dans le fichier gt.config.json !
Définissez-la plutôt comme variable d’environnement. La CLI lira automatiquement GT_API_KEY si elle est définie.
Voici quelques paramètres clés :
| Paramètre | Description |
|---|---|
--dry-run | Cet indicateur amènera la CLI à analyser et valider votre projet, sans communiquer avec l’API de GT. Utile pour valider votre base de code. |
--api-key | Sauf si vous utilisez --dry-run, vous devez fournir une clé d’API de production. |
--project-id | De même, sauf si vous utilisez --dry-run, vous devez fournir un ID de projet. |
--new, --locales <locales> | Locales vers lesquelles traduire votre projet. Elles 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, la 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 renverra une Error et s’arrêtera.
Comment trouvez-vous ce guide ?