generaltranslation v8
Brian LouResumen
En generaltranslation v8, estamos introduciendo cambios importantes en nuestra API y dejando en desuso algunas funciones y endpoints.
Las versiones anteriores de la API dejarán de ser compatibles.
Las versiones de generaltranslation anteriores a 7.5 probablemente producirán errores.
Las versiones de gtx-cli anteriores a 2.1.5 probablemente producirán errores.
Motivación
Para mejorar la experiencia de los desarrolladores, facilitar el desarrollo futuro y simplificar la gestión de las traducciones, estamos incorporando las ramas y dejando en desuso algunos endpoints de la API que ya no se utilizaban.
Características
Las funciones más recientes de la API admiten ramas, lo que te permite crear traducciones distintas para diferentes ramas de tu proyecto.
Ahora, cada archivo está asociado a una rama. El versionado de los archivos ahora se determina por branchId, fileId y versionId.
Antes, las traducciones de los archivos estaban asociadas a una sola rama. De forma predeterminada, las traducciones de archivos en caché usaban la versión del archivo actualizada más recientemente.
En la versión 8, al actualizar las traducciones de un archivo, ahora se usará 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 ramas de git:
- Actualizar un archivo fuente en una rama creará una nueva versión del archivo.
- Fusionar una rama en main generará un vínculo entre el archivo fuente de la rama main y el archivo fuente de 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 de esta rama harán referencia a traducciones anteriores de la rama main.
Para habilitar esta funcionalidad, agrega la opción --enable-branching al comando gtx-cli translate en la versión más reciente de gtx-cli.
De forma predeterminada, el uso de ramas está deshabilitado y todos los archivos del proyecto están asociados a la rama main.
Para usar esta funcionalidad, tu organización debe tener un plan de pago.
Cambios
generaltranslation
- En desuso
checkTranslationStatus - En desuso
downloadFile - Se renombró
downloadTranslatedFileadownloadFile- Dependiendo de si se especifica una configuración regional, descargará el archivo de origen o la traducción correspondiente
- Se modificaron los parámetros de
downloadFileydownloadFileBatch - En desuso
enqueueEntries - Se modificaron los parámetros de
enqueueFiles(se añadieron branchIds) - En desuso
fetchTranslations - En desuso
shouldSetupProject - Se modificaron los parámetros de
submitUserEditDiffs(se añadieron branchIds y los camposidpasaron a ser obligatorios) - Se modificaron los parámetros de
uploadSourceFiles(se añadieron branchIds) - Se modificaron los parámetros de
uploadTranslations(se añadieron branchIds) - Se modificaron los parámetros de
querySourceFile(se añadieron branchIds) - Se añadió
checkJobStatus - Se añadió
queryFileData - En desuso
checkSetupStatus(usacheckJobStatusen su lugar) - En desuso
checkFileTranslations(usaqueryFileDataen su lugar)
gtx-cli
- Se añadió la opción
--enable-branchingal comandotranslate - Se añadió la opción
--branchal comandotranslate- (Opcional) Anula la rama que se usará para la traducción
- Se añadió la opción
--disable-branch-detectional comandotranslate- (Opcional) Si se desactiva, el CLI no intentará detectar automáticamente las ramas que se usarán.
- Usa esta opción si
gitno está instalado o si el proyecto no es un repositorio de git.
- Se mejoró el seguimiento del progreso de la traducción y los registros
- Se mejoró el manejo de errores de traducción
- Se optimizó el rendimiento de la API para evitar subidas de archivos innecesarias a la API
gt-sanity
- Actualizado para usar la versión más reciente de
generaltranslation - Las traducciones usan la rama main de forma predeterminada.
- La compatibilidad con ramas para la vista previa de borradores de documentos se añadirá en una versión futura.