generaltranslation v8
Brian LouDescripción general
En generaltranslation v8, estamos realizando cambios significativos en nuestra API y retirando algunas funciones y endpoints de la API.
Las versiones anteriores de la API dejarán de recibir soporte.
Las versiones de generaltranslation anteriores a la 7.5 probablemente generarán errores.
Las versiones de gtx-cli anteriores a la 2.1.5 probablemente generarán errores.
Motivación
Para mejorar la experiencia de desarrollo, facilitar la evolución futura y simplificar la gestión de las traducciones, incorporamos branching y marcamos como obsoletos algunos endpoints de la API que ya no se utilizaban.
Funciones
Las funciones de la API más recientes admiten branching, lo que te permite crear traducciones diferentes para distintas ramas de tu proyecto.
Ahora cada archivo está asociado a una rama. El versionado de archivos ahora se determina por branchId, fileId y versionId.
Antes, las traducciones de archivos estaban asociadas a una sola rama. Las traducciones de archivos en caché usaban de forma predeterminada la versión del archivo actualizada más recientemente.
En la versión 8, al actualizar las traducciones de un archivo ahora se utilizará la versión más reciente del archivo en la rama especificada. El versionado está vinculado al historial de una rama, en lugar de a la marca de tiempo.
El nuevo sistema de versionado refleja el modelo de branching de git:
- Actualizar un archivo fuente en una rama creará una nueva versión del archivo.
- Hacer merge de una rama en main generará un enlace entre el archivo fuente en la rama main y el archivo fuente en la rama fusionada.
- Las traducciones futuras incorporarán traducciones de ambas ramas.
- Hacer checkout de una rama creará una nueva versión del archivo
- Las traducciones en esta rama harán referencia a traducciones anteriores de la rama main.
Para habilitar esta función, agrega el flag --enable-branching al comando gtx-cli translate en la versión más reciente de gtx-cli.
De forma predeterminada, el branching está deshabilitado y todos los archivos del proyecto están asociados con la rama main.
Para usar esta función, tu organización debe estar en un plan de pago.
Cambios
generaltranslation
- Obsoleto
checkTranslationStatus - Obsoleto
downloadFile downloadTranslatedFilerenombrado adownloadFile- Dependiendo de si se especifica una locale, descargará el archivo de origen o la traducción correspondiente
- Parámetros modificados de
downloadFileydownloadFileBatch - Obsoleto
enqueueEntries - Parámetros modificados de
enqueueFiles(se agregó branchIds) - Obsoleto
fetchTranslations - Obsoleto
shouldSetupProject - Parámetros modificados de
submitUserEditDiffs(se agregó branchIds y los campos id ahora son obligatorios) - Parámetros modificados de
uploadSourceFiles(se agregó branchIds) - Parámetros modificados de
uploadTranslations(se agregó branchIds) - Parámetros modificados de
querySourceFile(se agregó branchIds) - Se agregó
checkJobStatus - Se agregó
queryFileData - Obsoleto
checkSetupStatus(usacheckJobStatusen su lugar) - Obsoleto
checkFileTranslations(usaqueryFileDataen su lugar)
gtx-cli
- Se agregó la opción
--enable-branchingal comandotranslate - Se agregó la opción
--branchal comandotranslate- (Opcional) Permite sobrescribir la rama que se usará para la traducción
- Se agregó la opción
--disable-branch-detectional comandotranslate- (Opcional) Cuando está activada, la CLI no intentará detectar automáticamente las ramas que se van a usar.
- Usa esta opción si
gitno está instalado o si el proyecto no es un repositorio de git.
- Se mejoró el seguimiento y el registro del progreso de traducción
- Se mejoró el manejo de errores de traducción
- Se optimizó el rendimiento de la API para evitar cargas de archivos innecesarias a la API
gt-sanity
- Actualizado para usar la versión más reciente de
generaltranslation - De forma predeterminada, las traducciones usan la rama principal.
- La compatibilidad con ramas de vista previa de borradores de documentos se añadirá en una versión futura.