Con la integración con GitHub ve pull requests, runs de GitHub Actions, 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 GitHub
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 pull requests con el ID de la tarea aparecen en la tarea correspondiente.
- Los runs de GitHub Actions 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 vuelve a ejecutar los runs fallidos directamente desde FeatValue.
Encontrará un resumen en la página de la integración con GitHub.
Requisitos
- una cuenta de FeatValue de su empresa con al menos un cliente y un proyecto (vea Crear Proyectos)
- una cuenta u organización en github.com
- el permiso para instalar apps en esa cuenta u organización. En las organizaciones, son los owners. Los demás miembros pueden solicitar la instalación, y un owner la aprueba después en GitHub.
Conectar GitHub
-
Abrir la app
Haga clic en
Aplicaciones en la barra lateral izquierda, elija
GitHub y haga clic en
Instalar (vea
Conectar Aplicaciones).
-
Conectar con GitHub
Haga clic en
Conectar con GitHub. Un breve aviso indica los permisos que solicita la app (vea
Permisos de la GitHub App). Haga clic en
Continuar a GitHub.
-
Iniciar sesión en GitHub
Inicie sesión en GitHub y autorice la app de FeatValue.
-
Instalar la app o elegir organizaciones
Si la app aún no está instalada en ningún sitio, GitHub abre directamente la instalación: elija su cuenta o una organización, luego All repositories o, en Only select repositories, los repositorios que FeatValue puede ver, y haga clic en Install. Si la app ya está instalada en varias organizaciones, elija en una página de selección las organizaciones que quiere conectar. Después volverá a FeatValue.
Dé acceso solo a los repositorios que quiera vincular con proyectos de FeatValue. Puede cambiar la selección en cualquier momento en GitHub, en la app de FeatValue: en una cuenta personal en Settings › Applications › Installed GitHub Apps, en una organización en Organization settings › Third-party Access › GitHub Apps.
Permisos de la GitHub App
La app de FeatValue solicita a GitHub estos permisos:
- Metadata: read: nombres y datos básicos de los repositorios con acceso
- Contents: read: commits y comparaciones de ramas
- Pull requests: read: pull requests con título, estado y rama
- Actions: read & write: leer runs de GitHub Actions, escribir solo para volver a ejecutar un run
- Deployments: read: despliegues y entornos
La GitHub App solicita acceso de lectura al contenido del repositorio (Contents: read) porque GitHub solo entrega commits y comparaciones de ramas con este permiso. FeatValue lo usa solo para leer datos de commits (mensaje, autor, fecha y hora) y comparaciones de ramas, nunca el código fuente, y no guarda ningún archivo.
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
GitHub (vea
Apps conectadas). La página se llama
Vincular repositorios.
-
Buscar el repositorio
Los repositorios a los que ha dado acceso a la app aparecen en Repositorios en GitHub. Con Buscar repositorio acota la lista.
-
Elegir proyecto y vincular
Junto al repositorio, elija el Proyecto de FeatValue y haga clic en Vincular. FeatValue recupera los últimos días. No tiene que crear ningún webhook, los eventos llegan a través de la app de FeatValue.
Todos los vínculos aparecen en Repositorios vinculados. La columna Actualización muestra Al instante por webhook. Con Cambiar elige otro proyecto y con Desvincular elimina el vínculo.
Varias organizaciones en una conexión
Una conexión de FeatValue puede usar la app de todas las organizaciones y cuentas de GitHub en las que está instalada y a las que usted tiene acceso al conectar, por ejemplo su propia organización y las de sus clientes. La lista de la página Vincular repositorios está agrupada por organización.
-
Añadir una organización
Abra Ajustes › GitHub (la página Vincular repositorios) y haga clic en Añadir organización.
-
Elegir la organización
Elija una organización en la que la app ya esté instalada. Si no aparece, haga clic en Instalar en otra organización e instale allí la app en GitHub.
-
Vincular repositorios
Los repositorios de la organización aparecen en la lista. Vincúlelos como se describe arriba.
Varias empresas de FeatValue pueden usar la misma instalación, por ejemplo su agencia y su cliente con su propia cuenta de FeatValue.
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 pull 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.
- Los runs de GitHub Actions y los despliegues pertenecen a la tarea si se ejecutan para una de sus ramas, commits o pull requests.
Qué aparece en la tarea
La tarea muestra la sección Desarrollo con una línea compacta, por ejemplo: PR #12 fusionada · Workflow correcto · Desplegado en Staging. Con Mostrar detalles la despliega:
- Workflows: los runs de GitHub Actions, por ejemplo CI #57, con sus jobs y su estado
- Entornos de sus despliegues con un enlace para abrirlos, por ejemplo Staging y Production
- Pull requests, Ramas y Commits
Qué aparece en el proyecto
En el proyecto, la sección Desarrollo muestra los entornos con su último despliegue y el último run de la rama principal. Con Mostrar todas las ejecuciones de workflow ve la lista Últimas ejecuciones de workflow. 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 GitHub |
| 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, pull requests, workflows, 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:
- Pull request fusionado
- Workflow correcto
- Workflow fallido (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?.
Volver a ejecutar runs fallidos
Starter
Si un run de GitHub Actions falla o se cancela, usted lo vuelve a ejecutar directamente en FeatValue. En un run fallido, GitHub vuelve a ejecutar solo los jobs fallidos; en uno cancelado, el run completo. Está disponible a partir del plan Starter (vea Planes).
-
Permitir workflows
En el proyecto, abra los Ajustes de la sección Desarrollo. En Volver a ejecutar workflows desde FeatValue encontrará los workflows para los que GitHub ha notificado hasta ahora un run fallido, por ejemplo CI. Marque los workflows que deben aparecer en FeatValue y haga clic en Guardar.
-
También para clientes
Si su cliente también debe poder volver a ejecutar los workflows seleccionados, marque Los clientes también pueden volver a ejecutar los workflows seleccionados.
-
Volver a ejecutar
Un run fallido de un workflow permitido aparece con el botón Volver a ejecutar. Tras el clic, FeatValue muestra Reiniciado, y el resto lo sigue en el run.
Seguridad
- Solo repositorios con acceso y vinculados: La app de FeatValue solo ve los repositorios a los que usted da acceso durante la instalación. FeatValue solo asigna los ID de tarea en repositorios que usted ha vinculado con un proyecto, y solo dentro de ese proyecto.
- Sin código fuente: FeatValue solo lee datos de commits y comparaciones de ramas, nunca el código fuente, y no guarda archivos de su repositorio. Por eso la app solicita Contents: read (vea Permisos de la GitHub App).
- Webhooks verificados: GitHub firma cada entrega a FeatValue. FeatValue solo acepta llamadas con una firma válida.
- Pocos permisos de escritura: Lo único que la app puede cambiar es volver a ejecutar runs de GitHub Actions, y solo de los workflows que usted ha permitido.
- Desvincular en cualquier momento: Desvincular elimina un vínculo. Si desinstala la app en GitHub, FeatValue desvincula automáticamente los repositorios de esa organización.
Desconectar y desinstalar la app
Si desconecta GitHub en FeatValue, FeatValue solo elimina los vínculos de los repositorios. Lo que ya aparece en las tareas se mantiene. La app sigue instalada en GitHub hasta que la desinstale allí:
- Organización: En GitHub, abra Organization settings › Third-party Access › GitHub Apps, haga clic en Configure junto a la app de FeatValue y, al final de la página, en Uninstall.
- Cuenta personal: Abra Settings › Applications › Installed GitHub Apps, haga clic en Configure junto a la app de FeatValue y después en Uninstall.
Tras la desinstalación, FeatValue desvincula automáticamente los repositorios de esa organización.
Solución de problemas
Mi repositorio no aparece en la lista
FeatValue solo muestra los repositorios a los que ha dado acceso a la app. En GitHub, abra Settings › Applications › Installed GitHub Apps, elija la app de FeatValue y añada el repositorio en Repository access. En una organización, lo encontrará en los ajustes de la organización.
La instalación espera aprobación
Si no es owner de la organización, GitHub envía la solicitud de instalación a los owners. En cuanto un owner la apruebe, vuelva a conectar GitHub en FeatValue.
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 pull request?
- Si se pierde una entrega de GitHub, FeatValue recupera los datos en un máximo de 10 minutos.
Un run no se puede volver a ejecutar
Volver a ejecutar está disponible a partir del plan Starter. Además, el workflow tiene que estar permitido en los ajustes del proyecto, y el run tiene que haber fallado o haberse cancelado. Si aparece No se pudo volver a ejecutar, compruebe en GitHub si la app sigue instalada y puede ver el repositorio.
Falta una organización en la selección
FeatValue solo muestra organizaciones en las que la app está instalada y a las que su cuenta de GitHub tiene acceso. Instale la app con Instalar en otra organización o pídaselo a un owner de la organización.