Guía de Understanding Code

Understanding Code es una GitHub Action que ejecuta un análisis estático de tu repositorio y del último cambio (push o PR) y publica los resultados en un issue nuevo. Incluye métricas, detección de lenguajes, complejidad ciclomática, TODOs y sugerencias.

Funciona gratis dentro de GitHub Actions, sin base de datos ni servidores externos. Si añades una clave de OpenAI, los resúmenes pasan a ser generados por IA.

Crea el archivo .github/workflows/understanding-code.yml en tu repositorio:

name: Understanding Code

on:
  push:
  pull_request:

permissions:
  contents: read
  issues: write

jobs:
  understanding-code:
    runs-on: ubuntu-latest
    name: Analizar y publicar issue
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Understanding Code
        uses: DevLabs-Team/Understanding-Code@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

Haz commit y push. En unos segundos verás el primer issue con el análisis de tu repositorio.

Todos los inputs disponibles:

Resumen con IA

Añade el input openai_api_key y crea un repository secret llamado OPENAI_API_KEY:

      - name: Understanding Code
        uses: DevLabs-Team/Understanding-Code@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}

Un issue generado incluye: resumen del repositorio, lenguajes principales, los cambios del último push/PR, el análisis (heurístico o IA) y sugerencias.