Skip to content

informatorioar/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📖 Repositorio de Configuración de la Organización Informatorio

Este repositorio contiene los archivos de configuración y automatización para la organización Informatorio en GitHub.

🏗️ Estructura del Repositorio

.github/
├── .github/
│   └── workflows/
│       └── profile_readme.yml      # 🤖 Workflow de actualización automática del README
├── docs/
│   └── README.md                   # 📚 Documentación del repositorio (este archivo)
├── profile/
│   ├── README.md                   # 📄 README del perfil de la organización (generado)
│   └── README.md.j2               # 📝 Template Jinja2 para el README del perfil
└── scripts/
    ├── __init__.py                # 📦 Inicialización del paquete de scripts
    └── profile_readme.py          # 🐍 Script para generar el README del perfil

🎯 Propósito

Este repositorio especial .github permite configurar aspectos importantes de la organización:

  • 🌟 Perfil de la Organización: El archivo profile/README.md se muestra automáticamente en la página principal de la organización en GitHub
  • 🤖 Automatización: Los workflows en .github/workflows/ se ejecutan para mantener el contenido actualizado
  • 📝 Generación Dinámica: El sistema basado en templates permite mantener la información actualizada sin edición manual

🔧 Tecnologías Utilizadas

  • 🐍 Python 3.13+: Lenguaje principal para los scripts
  • 🎨 Jinja2: Motor de templates para generar contenido dinámico
  • 📦 uv: Gestor de dependencias y entornos virtuales de Python
  • ⚙️ GitHub Actions: Automatización y CI/CD
  • 📝 Markdown: Formato de documentación

🚀 Funcionalidades

📄 Generación Automática del README del Perfil

El archivo profile/README.md se genera automáticamente usando:

  1. 📝 Template: profile/README.md.j2 con sintaxis Jinja2
  2. 🐍 Script: scripts/profile_readme.py que procesa el template
  3. 🤖 Workflow: .github/workflows/profile_readme.yml que ejecuta el script

🔄 Triggers de Actualización

El README del perfil se actualiza automáticamente cuando:

  • 📝 Se modifica el template (profile/README.md.j2)
  • 🐍 Se actualiza el script (scripts/profile_readme.py)
  • 📅 Mensualmente (primer día del mes a las 00:00 UTC)
  • 🖱️ Manualmente a través del workflow dispatch

🎨 Características del README del Perfil

  • 📅 Información Actualizada: Solo incluye datos relevantes para 2025
  • 🎭 Interfaz Amigable: Uso extensivo de emojis e iconos para mejorar la experiencia visual
  • 📊 Datos Dinámicos: La información se actualiza automáticamente desde el script Python
  • 🔗 Enlaces Activos: Links a redes sociales, sitio web y contactos
  • 📱 Responsive: Formato optimizado para diferentes dispositivos

🛠️ Desarrollo y Mantenimiento

Estructura de Datos

El script profile_readme.py contiene una función get_template_data() que centraliza toda la información:

{
    "current_year": 2025,
    "program_name": "Informatorio",
    "province": "Chaco",
    "target_jobs_2030": "20,000",
    "website": "https://campus-informatorio.chaco.gob.ar/",
    "social_media": { ... },
    "contact": { ... },
    "courses": [ ... ],
    "specializations": [ ... ],
    # ... más datos
}

Modificar el Contenido

Para actualizar el contenido del README del perfil:

  1. 📝 Editar Template: Modifica profile/README.md.j2
  2. 🐍 Actualizar Datos: Modifica la función get_template_data() en scripts/profile_readme.py
  3. 🚀 Commit: Los cambios activarán automáticamente el workflow

Ejecutar Localmente

# Navegar al directorio de scripts
cd scripts

# Ejecutar el script con uv
uv run profile_readme.py

📊 Métricas y Monitoreo

  • 🔍 Workflow Status: Puedes ver el estado de las ejecuciones en la pestaña "Actions"
  • 📅 Última Actualización: El README incluye la fecha de última generación
  • 🔄 Frecuencia: Actualizaciones automáticas mensuales más triggers manuales

🤝 Contribución

Este repositorio es mantenido por el equipo de Informatorio. Para sugerir cambios:

  1. 🍴 Fork el repositorio
  2. 🌿 Crea una rama feature
  3. 💾 Commit tus cambios
  4. 📤 Abre un Pull Request

📞 Contacto


🤖 Sistema Automatizado de Documentación Generado y mantenido automáticamente - 2025

Profile README Workflow

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages