Retour

generaltranslation v8

Brian Lou avatarBrian Lou
generaltranslation8.0.0apitranslation

Vue d’ensemble

Dans generaltranslation v8, nous apportons des modifications importantes à notre API et marquons certaines fonctions et certains endpoints de l’API comme obsolètes.

Les anciennes versions de l’API ne seront plus prises en charge.

Les versions de generaltranslation antérieures à 7.5 entraîneront probablement des erreurs. Les versions de gtx-cli antérieures à 2.1.5 entraîneront probablement des erreurs.


Motivation

Pour améliorer l'expérience des développeurs, faciliter les développements futurs et simplifier la gestion des traductions, nous introduisons la gestion des branches et marquons comme obsolètes certains endpoints d'API qui n'étaient plus utilisés.


Fonctionnalités

Les fonctions d'API les plus récentes prennent en charge le branching, ce qui vous permet de créer différentes traductions pour différentes branches de votre projet.

Chaque fichier est désormais associé à une branche. La gestion de versions des fichiers est maintenant déterminée par branchId, fileId et versionId.

Auparavant, les traductions de fichiers étaient associées à une seule branche. Les traductions de fichiers mises en cache utilisaient par défaut la version la plus récemment mise à jour du fichier.

Dans la version 8, la mise à jour des traductions d'un fichier utilisera désormais la dernière version du fichier sur la branche spécifiée. La gestion de versions est liée à l'historique d'une branche, plutôt qu'à un horodatage.

Le nouveau système de gestion de versions reflète le modèle de branching de Git :

  • La mise à jour d'un fichier source sur une branche créera une nouvelle version du fichier.
  • La fusion d'une branche dans main générera un lien entre le fichier source sur la branche main et le fichier source sur la branche fusionnée.
    • Les futures traductions intégreront les traductions des deux branches.
  • Le checkout d'une branche créera une nouvelle version du fichier
    • Les traductions sur cette branche réutiliseront les traductions précédentes de la branche main.

Pour activer cette fonctionnalité, ajoutez l'option --enable-branching à la commande gtx-cli translate sur la dernière version de gtx-cli.

Par défaut, le branching est désactivé et tous les fichiers du projet sont associés à la branche main.

Pour utiliser cette fonctionnalité, votre organisation doit être sur une offre payante.

Modifications

generaltranslation

  • checkTranslationStatus obsolète
  • downloadFile obsolète
  • downloadTranslatedFile renommé en downloadFile
    • Selon qu’une locale est spécifiée ou non, cela téléchargera soit la source, soit la traduction correspondante
  • Paramètres modifiés de downloadFile et downloadFileBatch
  • enqueueEntries obsolète
  • Paramètres modifiés de enqueueFiles (ajout de branchIds)
  • fetchTranslations obsolète
  • shouldSetupProject obsolète
  • Paramètres modifiés de submitUserEditDiffs (ajout de branchIds, champs id désormais obligatoires)
  • Paramètres modifiés de uploadSourceFiles (ajout de branchIds)
  • Paramètres modifiés de uploadTranslations (ajout de branchIds)
  • Paramètres modifiés de querySourceFile (ajout de branchIds)
  • Ajout de checkJobStatus
  • Ajout de queryFileData
  • checkSetupStatus obsolète (utiliser checkJobStatus à la place)
  • checkFileTranslations obsolète (utiliser queryFileData à la place)

gtx-cli

  • Ajout de l’option --enable-branching à la commande translate
  • Ajout de l’option --branch à la commande translate
    • (Optionnel) Permet de choisir une autre branche à utiliser pour la traduction
  • Ajout de l’option --disable-branch-detection à la commande translate
    • (Optionnel) Lorsque cette option est activée, le CLI n’essaiera pas automatiquement de détecter les branches à utiliser.
    • Utilisez cette option si git n’est pas installé ou si le projet n’est pas un dépôt git.
  • Amélioration du suivi de la progression de la traduction et de la journalisation
  • Amélioration de la gestion des erreurs de traduction
  • Optimisation des performances de l’API pour éviter les envois de fichiers vers l’API lorsqu’ils ne sont pas nécessaires

gt-sanity

  • Mis à jour pour utiliser la dernière version de generaltranslation
  • Par défaut, les traductions utilisent la branche principale.
    • La prise en charge des branches pour l’aperçu des brouillons de documents sera ajoutée dans une prochaine version.