Saltearse al contenido
Nappai Documentation

GitHub Issues

El componente GitHub Issues te permite extraer los detalles de los issues de un repositorio de GitHub directamente dentro de tu dashboard de Nappai. Con solo proporcionar tu token de acceso, el nombre del repositorio y opcionalmente etiquetas o estado, obtendrás una lista estructurada de los issues que puedes usar en tus flujos de trabajo.

⚠️ ADVERTENCIA DE DEPRECACIÓN

Este componente está deprecado y será eliminado en una versión futura de Nappai. Por favor, migra a los componentes alternativos recomendados.

¿Cómo funciona?

El componente utiliza la clase GitHubIssuesLoader de la librería langchain_community. Cuando lo activas, se envía una solicitud a la API de GitHub con los parámetros que hayas configurado: token de acceso, nombre del repositorio, etiquetas y estado de los issues. La API devuelve los issues que coinciden con esos filtros. El componente convierte cada issue en un objeto Data, que incluye el contenido del issue (page_content) y metadatos como el número, el autor y la fecha de creación. Finalmente, devuelve una lista de estos objetos Data para que puedas procesarlos en tu flujo de trabajo.

Entradas

Campos de Entrada

Los siguientes campos están disponibles para configurar este componente. Cada campo puede estar visible en diferentes operaciones:

  • Access Token: Tu token de acceso personal de GitHub. Este token debe tener permisos de lectura sobre el repositorio que vas a consultar.
  • Labels: Lista de nombres de etiquetas. Solo se devolverán los issues que tengan al menos una de estas etiquetas.
  • Repository: El nombre completo del repositorio en formato owner/repo. Por ejemplo, octocat/Hello-World.
  • State: Estado de los issues que quieres recuperar. Puedes elegir entre open, closed o all.

Salidas

  • Data: Tipo de datos: Data (método: fetch_content).
    Cada elemento de la lista contiene el texto del issue y metadatos útiles (número, autor, fecha, etiquetas, etc.). Puedes usar esta salida para filtrar, mostrar o analizar los issues en tu dashboard.

Ejemplo de Uso

  1. Configura el componente

    • Access Token: ghp_XXXXXXXXXXXXXXXXXXXX
    • Repository: octocat/Hello-World
    • Labels: bug, enhancement
    • State: open

  2. Conecta la salida

    • Conecta la salida Data a un componente de Filtro para mostrar solo los issues con la etiqueta bug.
    • Luego, conecta el resultado a un componente de Visualización (por ejemplo, una tabla) para mostrar el número, título y autor de cada issue.

  3. Ejecuta el flujo

    • Al ejecutar, el componente recuperará todos los issues abiertos con las etiquetas bug o enhancement del repositorio octocat/Hello-World y los mostrará en tu dashboard.

Componentes Relacionados

  • GitHub Pull Requests – Extrae información de pull requests en lugar de issues.
  • GitHub Commits – Obtiene los commits de un repositorio.
  • GitHub Repositories – Lista y filtra repositorios públicos o privados.

Consejos y Mejores Prácticas

  • Mantén tu token seguro: No lo compartas públicamente y usa un token con el menor alcance necesario.
  • Usa etiquetas: Filtrar por etiquetas reduce la cantidad de datos que recibes y mejora el rendimiento.
  • Controla el estado: Si solo necesitas issues abiertos, selecciona open para evitar procesar datos innecesarios.
  • Revisa la documentación de GitHub: La API de GitHub tiene límites de tasa; si tu flujo necesita muchas peticiones, considera usar un token con mayor límite o implementar caché.

Consideraciones de Seguridad

  • Token de acceso: Asegúrate de que el token tenga solo los permisos de lectura necesarios (repo o public_repo).
  • Almacenamiento: Guarda el token en un lugar seguro dentro de Nappai (por ejemplo, en un almacén de secretos).
  • Rate limits: La API de GitHub impone límites de peticiones por hora. Si tu flujo hace muchas consultas, podrías alcanzar esos límites y recibir errores de tasa.
  • Privacidad de datos: Los issues pueden contener información sensible. Maneja los datos con cuidado y evita exponerlos en dashboards públicos.