Skip to content

Obtener todos los commits que hiciste durante la semana o el mes, y te da un reporte para poder presentarlo en tu pega o jira. Ya no necesitas recordar todo el tiempo que hiciste en el dia, la semana o el mes

Notifications You must be signed in to change notification settings

madkoding/git-reports

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📊 GitLab Activity Reporter

Programa para obtener cambios de repositorios GitLab y generar reportes detallados con IA.

✨ Características

  • 📅 Reportes únicos o semanales: Genera un reporte completo o divídelo en semanas
  • 🤖 IA integrada: Análisis inteligente con OpenAI GPT-4 (opcional)
  • 📊 Estadísticas detalladas: Commits, merge requests, y más
  • 🔧 Configuración simple: Archivos JSON fáciles de configurar
  • 📁 Múltiples repositorios: Analiza todos tus proyectos en una sola ejecución
  • 🚀 Scripts predefinidos: Comandos listos para usar
  • 📋 Reportes profesionales: Formato Markdown listo para compartir

Configuración

  1. Instalar dependencias:
npm install
  1. Configurar variables de entorno copiando el ejemplo:
cp .env.example .env

Edita .env y completa al menos:

GITLAB_TOKEN=tu_token_de_gitlab
OPENAI_API_KEY=tu_api_key_de_openai
  1. Configurar los archivos JSON (puedes partir de los ejemplos):
cp config/repositories.example.json config/repositories.json
cp config/user.example.json config/user.json
  • config/repositories.json: Lista de repositorios a analizar
  • config/user.json: Información del usuario a seguir

Uso

Reporte único (todo el período)

npm start -- --start-date 2024-01-01 --end-date 2024-01-31

Reportes semanales separados

npm start -- --weekly --start-date 2024-01-01 --end-date 2024-01-31

Scripts predefinidos

npm run report-month          # Reporte del mes actual
npm run report-month-weekly   # Reportes semanales del mes actual
npm run report-week          # Reporte de la última semana

Estructura de archivos de configuración

repositories.json

[
  {
    "titulo": "Mi Proyecto 1",
    "url": "https://gitlab.com/usuario/proyecto1"
  },
  {
    "titulo": "Mi Proyecto 2", 
    "url": "https://gitlab.com/usuario/proyecto2"
  }
]

user.json

{
  "emails": [
    "tu-email@ejemplo.com",
    "alias@empresa.com"
  ],
  "name": "Tu Nombre",
  "gitlab_username": "tu-usuario-gitlab"
}

About

Obtener todos los commits que hiciste durante la semana o el mes, y te da un reporte para poder presentarlo en tu pega o jira. Ya no necesitas recordar todo el tiempo que hiciste en el dia, la semana o el mes

Resources

Stars

Watchers

Forks