Ambiente di staging
Come predisporre le traduzioni per la revisione
Panoramica
gtx-cli stage è un comando che genera le traduzioni per il tuo progetto e le mette in staging per la revisione.
Questo comando è utile solo se hai abilitato la revisione umana nel tuo progetto.
Al momento, questo comando è supportato solo per le app che utilizzano gt-next o gt-react.
Utilizzo
Esegui questo nella pipeline CI prima di effettuare il build della tua app per la produzione.
npx gtx-cli stageNota: Questo comando richiede una chiave API di produzione! Procuratene una dalla piattaforma.
Il comando gtx-cli stage funziona come translate, ma invece di scaricare le traduzioni completate o pubblicarle sul CDN, le mette semplicemente in staging per la revisione.
Dopo aver eseguito gtx-cli stage, esegui gtx-cli translate per completare il processo e scaricare le traduzioni (se configurato).
Solo per l’ambiente di produzione!
Questo comando è pensato per le build di produzione e non va usato in sviluppo.
Prima di eseguirlo, assicurati di trovarti nel branch che verrà usato in produzione.
Ricorda anche di specificare la chiave API di produzione (GT_API_KEY) e l’ID progetto (GT_PROJECT_ID) nelle variabili d’ambiente.
Flag
| Parametro | Descrizione | Tipo | Opzionale | Predefinito |
|---|---|---|---|---|
--api-key | Specifica una API key di produzione | string | true | |
--project-id | Specifica l'ID del progetto | string | true | |
--version-id | Specifica un ID di versione (per impostazione predefinita, un hash del contenuto) | string | true | |
--config <path> | Specifica il percorso al file di configurazione di GT | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Specifica il percorso al file di configurazione TS o JS | string | true | |
--src <paths> | Elenco di pattern glob separati da spazi per individuare i file sorgente. Deve essere relativo alla directory radice. | [string] | true | [ 'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ] |
--dictionary <path> | Specifica il percorso al file del dizionario | string | true | |
--inline | Includi i tag <T> inline oltre al dizionario | boolean | true | true |
--timeout | Timeout della richiesta di traduzione in secondi | number | true | 600 |
--new, --locales <locales> | Locali in cui tradurre il progetto | [string] | true | |
--default-locale <locale> | Locale sorgente del progetto | string | true | en |
--ignore-errors | Ignora gli errori e forza la traduzione per i contenuti validi | flag | true | false |
--dry-run | Esegui il comando in modalità simulazione | flag | true | false |
Tutti questi parametri sono opzionali.
Non aggiungere la tua API key al file gt.config.json!
Impostala invece come variabile d'ambiente. La CLI leggerà automaticamente GT_API_KEY se è impostata.
Ci sono alcuni parametri chiave:
| Parametro | Descrizione |
|---|---|
--dry-run | Questo flag fa sì che la CLI analizzi e convalidi il progetto, ma non comunichi con la GT API. Utile per convalidare la codebase. |
--api-key | A meno che tu non stia usando --dry-run, devi fornire una API key di produzione. |
--project-id | Analogamente, a meno che tu non stia usando --dry-run, devi fornire un ID progetto. |
--new, --locales <locales> | Locali in cui tradurre il progetto. Verranno aggiunti ai locali specificati nel file gt.config.json. |
File di configurazione
Quando esegui gtx-cli stage, la CLI aggiunge automaticamente la proprietà stageTranslations: true al file gt.config.json.
Questa proprietà assicura che, se translate viene eseguito senza aver prima eseguito stage per una specifica versione di distribuzione, lo strumento CLI restituisca un errore e termini l’esecuzione.
Come valuti questa guida?