Indietro

generaltranslation v8

Brian Lou avatarBrian Lou
generaltranslation8.0.0apitranslation

Panoramica

In generaltranslation v8 stiamo introducendo modifiche significative alla nostra API e deprecando alcune funzioni ed endpoint.

Le versioni meno recenti dell'API non saranno più supportate.

Le versioni di generaltranslation precedenti alla 7.5 causeranno probabilmente errori. Le versioni di gtx-cli precedenti alla 2.1.5 causeranno probabilmente errori.


Motivazione

Per migliorare l'esperienza degli sviluppatori, agevolare lo sviluppo futuro e semplificare la gestione delle traduzioni, stiamo introducendo il branching e deprecando alcuni endpoint API non più utilizzati.


Funzionalità

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

Ogni file è ora associato a un branch. Il versionamento dei file è ora determinato da branchId, fileId e versionId.

In precedenza, le traduzioni dei file erano associate a un solo branch. Per impostazione predefinita, le traduzioni dei file memorizzate nella cache usavano la versione del file aggiornata più di recente.

Nella versione 8, l'aggiornamento delle traduzioni di un file userà ora la versione più recente del file nel branch specificato. Il versionamento è legato alla cronologia del branch, anziché al timestamp.

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

  • Aggiornare un file sorgente in un branch creerà una nuova versione del file.
  • Unire un branch in main genererà un collegamento tra il file sorgente nel branch main e il file sorgente nel branch unito.
    • Le traduzioni future incorporeranno le traduzioni di entrambi i branch.
  • Eseguire il checkout di un branch creerà una nuova versione del file
    • Le traduzioni in questo branch faranno riferimento alle traduzioni precedenti del branch main.

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

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

Per usare questa funzionalità, la tua organizzazione deve avere un piano a pagamento.

Modifiche

generaltranslation

  • checkTranslationStatus è in disuso
  • downloadFile è in disuso
  • downloadTranslatedFile rinominato in downloadFile
    • A seconda che venga specificata o meno un'impostazione regionale, scaricherà il file sorgente o la traduzione corrispondente
  • Parametri di downloadFile e downloadFileBatch modificati
  • enqueueEntries è in disuso
  • Parametri di enqueueFiles modificati (aggiunti branchIds)
  • fetchTranslations è in disuso
  • shouldSetupProject è in disuso
  • Parametri di submitUserEditDiffs modificati (aggiunti branchIds, i campi id sono ora obbligatori)
  • Parametri di uploadSourceFiles modificati (aggiunti branchIds)
  • Parametri di uploadTranslations modificati (aggiunti branchIds)
  • Parametri di querySourceFile modificati (aggiunti branchIds)
  • Aggiunto checkJobStatus
  • Aggiunto queryFileData
  • checkSetupStatus è in disuso (usa checkJobStatus al suo posto)
  • checkFileTranslations è in disuso (usa queryFileData al suo posto)

gtx-cli

  • Aggiunto il flag --enable-branching al comando translate
  • Aggiunto il flag --branch al comando translate
    • (Facoltativo) Sovrascrive il branch da usare per la traduzione
  • Aggiunto il flag --disable-branch-detection al comando translate
    • (Facoltativo) Se disabilitato, la CLI non tenterà automaticamente di rilevare i branch da usare.
    • Usa questo flag se git non è installato o se il progetto non è un repository Git.
  • Migliorati il monitoraggio dell'avanzamento della traduzione e la registrazione nei log
  • Migliorata la gestione degli errori di traduzione
  • Ottimizzate le prestazioni dell'API per evitare upload di file non necessari

gt-sanity

  • Aggiornato per utilizzare l'ultima versione di generaltranslation
  • Per impostazione predefinita, le traduzioni usano il branch main.
    • Il supporto per il branching dell'anteprima delle bozze dei documenti sarà aggiunto in una release futura.