Saltar al contenido

Previews de Gradle

Compila y comparte aplicaciones Android y herramientas nativas de línea de comandos directamente desde Gradle. Comienza con la guía del proyecto Gradle para conectar el proyecto y autenticarte.

Aplicaciones Android#

bash
./gradlew :app:tuistShareDebug

El plugin de configuración dev.tuist registra una tarea tuistShare<Variant> para cada variante de aplicación del Android Gradle Plugin (8.8.2 o posterior). Sustituye app y Debug por tu módulo de aplicación y variante, por ejemplo :app:tuistShareDemoDebug para un product flavor. La tarea compila el APK a través de las dependencias de artefactos declaradas en Gradle antes de publicarlo. También funciona cuando los resultados de compilación están actualizados o se restauran desde la caché de compilación.

Solo se admite un único APK de aplicación universal firmado. La variante debug de Android suele usar una clave de firma de depuración; las variantes release necesitan tu propia configuración de firma. La tarea verifica la firma del APK antes de la autenticación o la subida. Se rechazan los APK sin firmar, no válidos, de instrumentación y divididos. Los módulos de biblioteca, los APK de test y los Android App Bundles (.aab) no son objetivos de publicación.

Herramientas nativas de línea de comandos#

Los proyectos que usan el plugin cpp-application o swift-application de Gradle obtienen una tarea de compartición para cada binario nativo:

bash
./gradlew :app:tuistShareMainDebug

La tarea compila y empaqueta la distribución instalada, incluido su lanzador y las bibliotecas de runtime. Usa tuistShareMainRelease para el binario de release. Los proyectos dirigidos a varias máquinas tienen una tarea para cada binario; ejecuta ./gradlew :app:tasks --all para encontrar sus nombres.

Se admiten ejecutables nativos de macOS y Linux para arm64 o x86_64. Compila en la plataforma objetivo con la toolchain requerida por tu plugin de Gradle. Las aplicaciones JVM y sus scripts de lanzador generados no son compatibles con esta integración.

Comportamiento de publicación#

Las tareas de compartición publican usando las credenciales de Tuist existentes del plugin, sin invocar la CLI de Tuist. Las tareas ordinarias assemble, build y de test nunca publican previews.

Después de compartir, abre Previews en tu proyecto para copiar el enlace. Repetir la compartición de la misma compilación y track reutiliza su publicación, incluso después de un acierto de caché de compilación. Las subidas fallidas o no confirmadas hacen que falle la tarea de compartición; no se informan como previews exitosos.

CI y tracks#

Configura la autenticación de CI con las mismas credenciales que usas para otras funcionalidades autenticadas del plugin y solicita la publicación explícitamente:

bash
./gradlew :app:tuistShareDebug --track nightly

Añade --track nightly a una tarea de compartición nativa de la misma manera. Las tareas usan el proyecto de Tuist configurado, la URL del servidor y la configuración de proxy. La publicación de previews siempre requiere autenticación. Estos tasks no adjuntan metadatos de revisión de Git, notas de release ni comentarios automáticos de pull request.

Las publicaciones de artefactos expiran tras 30 días en Tuist alojado. Las instancias autoalojadas usan TUIST_APP_PREVIEW_RETENTION_DAYS; dejarlo sin configurar desactiva la caducidad para esta familia. Las publicaciones caducadas no pueden reactivarse repitiendo la misma acción.

Compartir un APK existente#

Para un APK compilado fuera de este flujo de trabajo, o para incluir notas de release con el flujo de subida heredado, la CLI sigue disponible:

bash
tuist share app/build/outputs/apk/debug/app-debug.apk \
--track nightly --release-notes "Improve checkout"

Consulta Ejecutar una preview para ejecutar compilaciones publicadas, gestionar el acceso, los tracks y los badges de README.

Canales con tuist share#

Para flujos de trabajo que publican con tuist share, usa --track para seleccionar un canal:

bash
tuist share App --track beta
tuist share App --track nightly

Notas de la versión#

Usa canales para grupos de entornos y notas de la versión para el propósito de una compilación individual:

bash
tuist share App --track QA --release-notes "Fix sign-in and improve the checkout flow"

Reemplaza App por el nombre de tu app, la ruta del archivo de la aplicación o la distribución ejecutable y su opción --executable. Las notas de la versión son texto plano opcional, de hasta 10.000 caracteres. La primera línea no vacía aparece como un fragmento de una sola línea en las listas de previsualizaciones, de modo que los números de compilación y otra información identificativa son visibles de un vistazo. Las líneas largas se truncan; las notas completas aparecen en las páginas de detalle. Las búsquedas coinciden con los nombres visibles y las notas de la versión completas, incluidas las líneas que no se muestran en el fragmento. Se admiten notas multilínea, por ejemplo --release-notes "$(< release-notes.txt)". No cambian el nombre visible de la app ni su canal.

Compatibilidad#

Las notas de la versión no cambian a qué previsualización pertenece una compilación. Se conservan las primeras notas que recibe una previsualización: una subida posterior puede añadir notas a una previsualización que no tenga, pero no puede sobrescribir ni borrar las existentes. Las previsualizaciones subidas antes de que existieran las notas de la versión siguen siendo válidas sin ellas.

Los despliegues autoalojados necesitan una versión del servidor que admita notas de la versión y filtrado por canal, junto con un cliente actualizado. Los servidores antiguos ignoran las notas. Para los filtros de canal y búsqueda de los endpoints de listado, consulta la referencia de la API.

Comentarios en solicitudes de pull/merge#

Integración con Git forge necesaria

Para obtener comentarios automáticos en solicitudes de pull/merge, integra tu proyecto remoto con un Git forge: GitHub, Cursor Origin o Entire.

Una vez que tu proyecto Tuist esté conectado con tu plataforma Git, añade tuist share tras una compilación exitosa de la aplicación en CI. Tuist publicará un enlace de previsualización directamente en tus solicitudes de pull/merge, para que los revisores puedan probar sin compilar localmente:

Comentario de la app de GitHub con un enlace a Tuist Preview

Automatizaciones#

Usa --json para obtener salida JSON de tuist share:

bash
tuist share --json

Usa el resultado para automatizaciones personalizadas, como publicar un mensaje en Slack desde CI. La clave url contiene el enlace completo a la previsualización; qrCodeURL apunta a una imagen de código QR para abrir la previsualización en un dispositivo:

json
{
"id": 1234567890,
"url": "https://tuist.dev/preview/1234567890",
"qrCodeURL": "https://tuist.dev/preview/1234567890/qr-code.svg"
}