Vue d’ensemble

Dans generaltranslation v8, nous apportons des modifications importantes à notre API et déprécions certaines fonctions et certains points de terminaison.

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 évolutions futures et simplifier la gestion des traductions, nous introduisons la gestion des branches et déprécions certains points de terminaison d’API qui n’étaient plus utilisés.

---

Fonctionnalités

Les fonctions d’API les plus récentes prennent désormais en charge les branches, 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. Le versionnage des fichiers est maintenant déterminé par branchId, fileId et versionId.

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

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. Le versionnage est désormais lié à l’historique d’une branche plutôt qu’à l’horodatage.

Le nouveau système de versionnage reprend le modèle de branches de Git :

• Mettre à jour un fichier source sur une branche crée une nouvelle version du fichier.
• Fusionner une branche dans main génère un lien entre le fichier source de la branche main et le fichier source de la branche fusionnée.
  • Les traductions futures intégreront les traductions des deux branches.
• Basculer sur une branche crée une nouvelle version du fichier
  • Les traductions de cette branche s’appuieront sur les traductions précédentes de la branche main.

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

Par défaut, la gestion des branches est désactivée et tous les fichiers du projet sont associés à la branche main.

Pour utiliser cette fonctionnalité, votre organisation doit disposer d’une offre payante.

Changements

generaltranslation

• checkTranslationStatus est déprécié
• downloadFile est déprécié
• downloadTranslatedFile a été renommé en downloadFile
  • Selon qu’un paramètre régional est indiqué ou non, il téléchargera soit la source, soit la traduction correspondante
• Paramètres de downloadFile et downloadFileBatch modifiés
• enqueueEntries est déprécié
• Paramètres de enqueueFiles modifiés (ajout de branchIds)
• fetchTranslations est déprécié
• shouldSetupProject est déprécié
• Paramètres de submitUserEditDiffs modifiés (ajout de branchIds, champs id rendus obligatoires)
• Paramètres de uploadSourceFiles modifiés (ajout de branchIds)
• Paramètres de uploadTranslations modifiés (ajout de branchIds)
• Paramètres de querySourceFile modifiés (ajout de branchIds)
• Ajout de checkJobStatus
• Ajout de queryFileData
• checkSetupStatus est déprécié (utilisez checkJobStatus à la place)
• checkFileTranslations est déprécié (utilisez queryFileData à la place)

gtx-cli

• Ajout de l’option --enable-branching à la commande translate
• Ajout de l’option --branch à la commande translate
  • (Facultatif) Remplace la branche à utiliser pour la traduction
• Ajout de l’option --disable-branch-detection à la commande translate
  • (Facultatif) Lorsqu’elle est désactivée, la CLI n’essaie 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 des traductions et de la journalisation
• Amélioration de la gestion des erreurs de traduction
• Optimisation des performances de l’API pour éviter les uploads de fichiers inutiles

gt-sanity

• Mise à jour pour utiliser la dernière version de generaltranslation
• Par défaut, les traductions utilisent la branche main.
  • La prise en charge de la gestion des branches pour la prévisualisation des brouillons de documents sera ajoutée dans une prochaine version.