Entorno de staging
Cómo preparar tus traducciones para revisión
Descripción general
gtx-cli stage es un comando que genera traducciones para tu proyecto y las deja listas para revisión.
Este comando solo resulta útil si has habilitado la revisión humana en tu proyecto.
Actualmente, este comando solo es compatible con aplicaciones que usan gt-next o gt-react.
Uso
Ejecuta esto en tu pipeline de CI antes de compilar tu app para producción.
npx gtx-cli stageNota: ¡Este comando requiere una clave de API de producción! Consíguela en la plataforma.
El comando gtx-cli stage funciona igual que translate, pero en lugar de descargar las traducciones finalizadas o publicarlas en el CDN (Red de distribución de contenido), simplemente las deja en etapa de revisión.
Después de ejecutar gtx-cli stage, deberías ejecutar gtx-cli translate para completar el proceso y descargar las traducciones (si está configurado así).
¡Solo para uso en producción!
Este comando está destinado a compilaciones de producción y no debe usarse en desarrollo.
Antes de ejecutarlo, asegúrate de estar en la rama que se usará para producción.
Recuerda también especificar tu clave de API de producción (GT_API_KEY) y el id de proyecto (GT_PROJECT_ID) en tus variables de entorno.
Flags
| Parameter | Descripción | Tipo | Opcional | Valor predeterminado |
|---|---|---|---|---|
--api-key | Especifica una clave de API de producción | string | true | |
--project-id | Especifica el id del proyecto | string | true | |
--version-id | Especifica un id de versión (de forma predeterminada, un hash del contenido) | string | true | |
--config <path> | Especifica la ruta al archivo de configuración de GT | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Especifica la ruta al archivo de configuración de TS o JS | string | true | |
--src <paths> | Lista de patrones glob separados por espacios para hacer match con archivos fuente. Deben ser relativos al directorio raíz. | [string] | true | [ 'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ] |
--dictionary <path> | Especifica la ruta al archivo del diccionario | string | true | |
--inline | Incluye etiquetas <T> en línea además del diccionario | boolean | true | true |
--timeout | Tiempo de espera de la solicitud de traducción en segundos | number | true | 600 |
--new, --locales <locales> | Locales a las que traducir tu proyecto | [string] | true | |
--default-locale <locale> | La locale de origen del proyecto | string | true | en |
--ignore-errors | Ignora errores y fuerza la traducción del contenido válido | flag | true | false |
--dry-run | Ejecuta el comando en modo de simulación | flag | true | false |
Todos estos parámetros son opcionales.
¡No agregues tu clave de API al archivo gt.config.json!
En su lugar, configúrala como una variable de entorno. La CLI leerá automáticamente GT_API_KEY si está definida.
Hay algunos parámetros clave:
| Parameter | Descripción |
|---|---|
--dry-run | Este flag hará que la CLI analice y valide tu proyecto, pero no se comunicará con la API de GT. Es útil para validar tu base de código. |
--api-key | A menos que uses --dry-run, debes proporcionar una clave de API de producción. |
--project-id | De forma similar, a menos que uses --dry-run, debes proporcionar un id de proyecto. |
--new, --locales <locales> | Locales a las que traducir tu proyecto. Se añadirán a las locales especificadas en tu archivo gt.config.json. |
Archivo de configuración
Al ejecutar gtx-cli stage, la CLI añadirá automáticamente la propiedad stageTranslations: true a tu archivo gt.config.json.
Esta propiedad garantiza que, si se ejecuta translate sin haber ejecutado primero stage para una versión de despliegue específica, la herramienta de la CLI lanzará un Error y finalizará.
¿Qué te ha parecido esta guía?