Con la integración con GitLab ve merge requests, pipelines, entornos y commits directamente en sus tareas de FeatValue. Sus clientes saben con palabras sencillas si su cambio está en curso, en staging para probar o ya publicado.
Para qué sirve la integración con GitLab
Las empresas de software y las agencias web reciben una y otra vez la misma pregunta: “¿Ya está online?”. Con la integración, FeatValue la responde en la tarea:
- Las ramas, commits y merge requests con el ID de la tarea aparecen en la tarea correspondiente.
- Las pipelines y los despliegues muestran si el cambio se ha probado y a qué entorno ha llegado.
- FeatValue anota los pasos importantes como comentarios en el historial de la tarea.
- Para cada proyecto usted decide qué ven sus clientes.
- Usted inicia jobs manuales, como un despliegue, directamente desde FeatValue.
Encontrará un resumen en la página de la integración con GitLab.
Requisitos
- una cuenta de FeatValue de su empresa con al menos un cliente y un proyecto (vea Crear Proyectos)
- GitLab en gitlab.com o como instancia propia, accesible por https
- al menos el rol Maintainer en los proyectos de GitLab que quiera vincular. Así FeatValue puede crear el webhook.
Conectar GitLab
-
Abrir la app
Haga clic en
Aplicaciones en la barra lateral izquierda, elija
GitLab y haga clic en
Instalar (vea
Conectar Aplicaciones). Aparece la página
Conectar GitLab con la pregunta
¿Dónde está su GitLab?
-
gitlab.com
Elija gitlab.com y haga clic en Continuar. Inicie sesión en GitLab y permita el acceso. Así FeatValue obtiene acceso a sus proyectos.
-
Instancia propia de GitLab
Elija Instancia propia de GitLab. Introduzca la dirección https en Dirección de la instancia, por ejemplo https://gitlab.example.com, y un token en Personal access token. Haga clic en Continuar.
¿Qué token necesito para una instancia propia?
Cree el token en GitLab en Preferencias › Access tokens:
- Ámbito:
api. Los ámbitos de solo lectura como read_api no bastan, porque FeatValue crea webhooks e inicia jobs manuales.
- Rol: El usuario del token necesita al menos el rol Maintainer en los proyectos.
- Fecha de caducidad: Cuando el token caduca, dejan de llegar datos nuevos. Cree uno nuevo y vuelva a conectar GitLab.
Lo ideal es usar un usuario propio o un token de grupo para la integración. Así no depende de la cuenta de una sola persona.
Vincular un repositorio con un proyecto
Cada repositorio pertenece exactamente a un proyecto de FeatValue. Solo los repositorios vinculados llegan a FeatValue.
-
Abrir Vincular repositorios
Abra
Ajustes › Empresa › Integraciones y apps y elija
GitLab (vea
Apps conectadas). La página se llama
Vincular repositorios.
-
Buscar el repositorio
Sus repositorios aparecen en Repositorios en GitLab. Con Buscar repositorio acota la lista.
-
Elegir proyecto y vincular
Junto al repositorio, elija el Proyecto de FeatValue y haga clic en Vincular. FeatValue crea un webhook en GitLab y recupera los últimos días.
Todos los vínculos aparecen en Repositorios vinculados. La columna Actualización muestra Al instante por webhook o Cada 10 minutos. Con Cambiar elige otro proyecto y con Desvincular elimina el vínculo; FeatValue borra entonces también el webhook.
Usar correctamente el ID de la tarea
Cada tarea de FeatValue tiene un ID, por ejemplo abc123-4. Lo encontrará en la tarea. Ponga este ID en uno de estos lugares:
| Dónde |
Ejemplo |
| Nombre de la rama |
abc123-4-formulario-contacto |
| Mensaje del commit |
abc123-4 Hacer obligatorio el teléfono |
| Título o descripción de la merge request |
Formulario de contacto: teléfono obligatorio (abc123-4) |
- Las mayúsculas y minúsculas no importan, y se admite una
# delante.
- Si el ID está en el nombre de la rama, solo cuentan los commits que existen únicamente en esa rama. Los commits de la rama principal que se arrastran al crear la rama no aparecen en la tarea.
- Los commits de otras ramas solo aparecen si el ID está en su mensaje de commit.
- El ID solo vale dentro del proyecto vinculado. FeatValue nunca asigna repositorios vinculados a otro proyecto o sin vincular.
- Las pipelines y los despliegues pertenecen a la tarea si se ejecutan para una de sus ramas, commits o merge requests.
Qué aparece en la tarea
La tarea muestra la sección Desarrollo con una línea compacta, por ejemplo: MR !12 fusionada · Pipeline correcta · Desplegado en Staging. Con Mostrar detalles la despliega:
- Pipelines con etapas y jobs y su estado
- Entornos con un enlace para abrirlos, por ejemplo Staging y Production
- Merge requests, Ramas y Commits
Qué aparece en el proyecto
En el proyecto, la sección Desarrollo muestra los entornos con su último despliegue y la última pipeline de la rama principal. Con Mostrar todas las pipelines ve los Últimos pipelines. Ahí también encontrará los Ajustes del proyecto.
¿Qué ven los clientes?
En los Ajustes de la sección Desarrollo del proyecto, elija en ¿Qué ven los clientes?:
| Ajuste |
Su cliente ve |
| Nada |
ninguna información de GitLab |
| Estado simple |
una frase sin términos técnicos: En curso, Publicado en Staging con el enlace pruébalo aquí, o Publicado con el enlace verlo ahora |
| Detalles |
las secciones que marque en Detalles para clientes: commits, ramas, merge requests, pipelines, entornos y comentarios de historial |
Pueden cambiar este ajuste las personas de su empresa que pueden editar el proyecto. Cómo prueba y acepta después su cliente se explica en Revisión y aceptación.
Configurar los comentarios de historial
FeatValue anota los pasos importantes como comentarios en el historial de la tarea. En Comentarios de historial en la tarea elige para cada proyecto qué eventos crean un comentario:
- Merge request fusionada
- Pipeline correcta
- Pipeline fallida (con jobs fallidos)
- Desplegado en entorno
Los eventos desmarcados siguen actualizando el estado en la tarea, pero ya no crean comentario. Que su cliente vea los comentarios depende del ajuste en ¿Qué ven los clientes?.
Ejecutar jobs desde FeatValue
Starter
Usted inicia los jobs manuales de su pipeline, por ejemplo deploy-production, directamente en FeatValue. Está disponible a partir del plan Starter (vea Planes).
-
Permitir jobs
En el proyecto, abra los Ajustes de la sección Desarrollo. En Ejecutar jobs desde FeatValue encontrará los jobs manuales que GitLab ha notificado hasta ahora. Marque los jobs que deben aparecer en FeatValue y haga clic en Guardar.
-
También para clientes
Si su cliente también debe poder iniciar los jobs seleccionados, marque Los clientes también pueden ejecutar los jobs seleccionados.
-
Ejecutar un job
Cuando un job permitido espera su inicio manual, aparece con el botón Ejecutar. Tras el clic, FeatValue muestra Iniciado, y el resto lo sigue en la pipeline.
Si aparece Aún no se han notificado jobs manuales., todavía no se ha ejecutado ninguna pipeline con un job manual. En cuanto GitLab notifique uno, podrá permitirlo.
Seguridad
- Solo repositorios vinculados: FeatValue solo lee los repositorios que usted ha vinculado con un proyecto y asigna los ID de tarea solo dentro de ese proyecto.
- Sin código: FeatValue no guarda archivos de su repositorio, solo información sobre ramas, commits, merge requests, pipelines y entornos.
- Webhook verificado: Cada webhook recibe su propio token secreto. FeatValue solo acepta llamadas que envían este token.
- Sus permisos en GitLab: FeatValue trabaja con los permisos del inicio de sesión o del token. Solo puede iniciar los jobs que usted ha permitido.
- Desvincular en cualquier momento: Desvincular elimina un vínculo, y FeatValue borra el webhook.
Solución de problemas
Mi repositorio no aparece en la lista
FeatValue solo muestra los repositorios en los que tiene al menos el rol Maintainer. Compruebe su rol en GitLab o busque el nombre con Buscar repositorio.
No se pudo crear el webhook
El vínculo muestra entonces Cada 10 minutos en lugar de Al instante por webhook. En ese caso FeatValue consulta GitLab cada 10 minutos, así que no se pierde nada, solo llega más tarde. Causas habituales: le falta el rol Maintainer, o su instancia de GitLab no puede enviar peticiones a internet. Compruébelo y después haga clic en Cambiar y de nuevo en Vincular.
No aparece nada en la tarea
- ¿Está el repositorio vinculado con el proyecto al que pertenece la tarea?
- ¿Está el ID completo de la tarea en el nombre de la rama, en el mensaje del commit o en la merge request?
- Sin webhook, los datos nuevos tardan hasta 10 minutos en llegar.
GitLab no aceptó el token
Compruebe la dirección de la instancia, el token y el ámbito api. El token no debe haber caducado.
Un job no se puede iniciar
Ejecutar jobs está disponible a partir del plan Starter. Además, el job tiene que estar permitido en los ajustes del proyecto y estar esperando su inicio manual. Si aparece No se pudo iniciar, compruebe en GitLab si el inicio de sesión todavía puede iniciar el job.