Indietro

generaltranslation v8

Brian Lou avatarBrian Lou
generaltranslation8.0.0apitranslation

Panoramica

In generaltranslation v8 stiamo apportando modifiche significative alla nostra API e stiamo deprecare alcune funzioni ed endpoint dell'API.

Le versioni precedenti dell'API non saranno più supportate.

Le versioni di generaltranslation precedenti alla 7.5 potrebbero generare errori. Le versioni di gtx-cli precedenti alla 2.1.5 potrebbero generare errori.


Motivazione

Per migliorare l'esperienza degli sviluppatori, facilitare gli sviluppi futuri e semplificare la gestione delle traduzioni, stiamo introducendo il branching ed eliminando alcuni endpoint API che non erano più utilizzati.


Funzionalità

Le funzioni API più recenti supportano il branching, che ti permette di creare traduzioni diverse per branch diversi del tuo progetto.

Ora ogni file è associato a un branch. Il versioning dei file è ora determinato da branchId, fileId e versionId.

In precedenza, le traduzioni dei file erano associate a un singolo branch. Le traduzioni dei file in cache usavano per impostazione predefinita la versione del file aggiornata più di recente.

Nella versione 8, l'aggiornamento delle traduzioni di un file userà ora l'ultima versione del file sul branch specificato. Il versioning è collegato alla cronologia di un branch invece che al timestamp.

Il nuovo sistema di versioning rispecchia il modello di branching di git:

  • L'aggiornamento di un file sorgente su un branch creerà una nuova versione del file.
  • Il merge di un branch in main genererà un collegamento tra il file sorgente sul branch main e il file sorgente sul branch unito.
    • Le traduzioni future incorporeranno le traduzioni di entrambi i branch.
  • Il checkout di un branch creerà una nuova versione del file
    • Le traduzioni su questo branch faranno riferimento alle traduzioni precedenti del branch main.

Per abilitare questa funzionalità, aggiungi il flag --enable-branching al comando gtx-cli translate sull'ultima versione di gtx-cli.

Per impostazione predefinita, il branching è disabilitato e tutti i file del progetto sono associati al branch main.

Per utilizzare questa funzionalità, la tua organizzazione deve disporre di un piano a pagamento.

Modifiche

generaltranslation

  • Deprecato checkTranslationStatus
  • Deprecato downloadFile
  • Rinominato downloadTranslatedFile in downloadFile
    • A seconda che venga specificata o meno una locale, scaricherà il sorgente oppure la traduzione corrispondente
  • Modificati i parametri di downloadFile e downloadFileBatch
  • Deprecato enqueueEntries
  • Modificati i parametri di enqueueFiles (aggiunti branchIds)
  • Deprecato fetchTranslations
  • Deprecato shouldSetupProject
  • Modificati i parametri di submitUserEditDiffs (aggiunti branchIds, resi obbligatori i campi id)
  • Modificati i parametri di uploadSourceFiles (aggiunti branchIds)
  • Modificati i parametri di uploadTranslations (aggiunti branchIds)
  • Modificati i parametri di querySourceFile (aggiunti branchIds)
  • Aggiunto checkJobStatus
  • Aggiunto queryFileData
  • Deprecato checkSetupStatus (usa checkJobStatus al suo posto)
  • Deprecato checkFileTranslations (usa queryFileData al suo posto)

gtx-cli

  • Aggiunta l'opzione --enable-branching al comando translate
  • Aggiunta l'opzione --branch al comando translate
    • (Opzionale) Sovrascrive il branch da usare per la traduzione
  • Aggiunta l'opzione --disable-branch-detection al comando translate
    • (Opzionale) Quando è disabilitata, la CLI non tenterà automaticamente di rilevare i branch da usare.
    • Usa questa opzione se git non è installato o se il progetto non è un repository git.
  • Migliorato il monitoraggio dell'avanzamento e il logging delle traduzioni
  • Migliorata la gestione degli errori di traduzione
  • Ottimizzate le prestazioni dell'API per evitare upload di file non necessari verso l'API

gt-sanity

  • Aggiornato per utilizzare l'ultima versione di generaltranslation
  • Le traduzioni utilizzano per impostazione predefinita il branch principale.
    • Il supporto per i branch di anteprima delle bozze dei documenti sarà aggiunto in una versione futura.