Saltar a contenido

UD 1 - Documentación, control de versiones e integración continua

Unidad 1: Documentación, control de versiones e integración continua

1. Contexto y normativa

Esta unidad pertenece al módulo profesional Despliegue de aplicaciones web del ciclo formativo de Desarrollo de Aplicaciones Web. Su contenido se apoya en la normativa oficial del módulo y contribuye al Resultado de Aprendizaje 6 (RA 6): elaborar documentación de aplicaciones web seleccionando herramientas de generación, control de versiones e integración continua.

La unidad avanza desde la colaboración y la cultura DevOps hasta la creación de documentación, el control de cambios con Git y la automatización de comprobaciones y publicaciones con GitHub Actions.

2. Resultado de aprendizaje

RA 6: Elabora la documentación de la aplicación web evaluando y seleccionando herramientas de generación de documentación, control de versiones y de integración continua.

3. Criterios de evaluación

Los ocho criterios del RA 6 se trabajan de forma relacionada a lo largo de la unidad:

Código Criterio de evaluación
CE 6.a Se han identificado diferentes herramientas de generación de documentación.
CE 6.b Se han documentado los componentes software utilizando los generadores específicos de las plataformas.
CE 6.c Se han utilizado diferentes formatos para la documentación.
CE 6.d Se han utilizado herramientas colaborativas para la elaboración y mantenimiento de la documentación.
CE 6.e Se ha instalado, configurado y utilizado un sistema de control de versiones.
CE 6.f Se ha garantizado la accesibilidad y seguridad de la información y código almacenada por el sistema de control de versiones.
CE 6.g Se ha documentado la instalación, configuración y uso del sistema de control de versiones utilizado.
CE 6.h Se han utilizado herramientas para la integración continua del código.

4. Contenidos y teoría

La secuencia va desde los fundamentos de colaboración hasta la automatización de un proceso de documentación y despliegue:

  1. 1.1. DevOps, CI/CD y despliegue de aplicaciones: cultura DevOps, colaboración, integración continua, entrega continua, despliegue continuo y etapas de un pipeline. Introduce el CE 6.h.
  2. 1.2. Documentación de software y herramientas: tipos de documentación, audiencias, formatos, herramientas de generación y publicación; incluye un ejemplo de KDoc y Dokka. Trabaja los CE 6.a–6.d.
  3. 1.3. Git y GitHub: estados y operaciones de Git, historial, ramas, repositorios remotos, colaboración, pull requests y seguridad. Trabaja los CE 6.d–6.g.
  4. 1.4. GitHub Actions: estructura de workflows, eventos, jobs, pruebas, permisos y automatización de documentación y publicaciones. Trabaja el CE 6.h.

Los criterios se relacionan entre sí: la documentación se versiona y mantiene en equipo, mientras que la integración continua permite comprobar y automatizar parte de ese trabajo.

5. Prácticas guiadas

La actividad de la unidad es CI/CD y documentación con GitHub Actions. Se trabaja de forma incremental:

  1. Comprensión y validación: partir del repositorio base, leer el script y el workflow, ejecutarlo manualmente y observar tanto pruebas correctas como fallidas. Esta primera parte sirve de toma de contacto y no se entrega.
  2. Mejora obligatoria: adaptar el proyecto propio para generar documentación en HTML y, al menos, otro formato; automatizar el proceso con GitHub Actions y documentar herramientas, comandos, evidencias y funcionamiento en el README.md.
  3. Ampliación opcional: construir un sitio con MkDocs y publicarlo en GitHub Pages mediante un workflow.

El repositorio entregado debe permitir que el profesorado clone el proyecto y ejecute el workflow para comprobar su funcionamiento.

Como apoyo, puedes consultar la actividad complementaria con propuestas para ampliar el workflow.

6. Evaluación y evidencias

La práctica y el cuestionario asociado sirven para demostrar la aplicación de los criterios del RA 6. Se valorará que:

  • el workflow se ejecuta y genera la documentación en HTML y otro formato;
  • el README.md explica herramientas, comandos, eventos, pasos y formas de reproducir el proceso;
  • se documentan componentes con el formato elegido y se enlazan los resultados;
  • los commits, las pull requests y las evidencias permiten revisar los cambios;
  • la configuración de acceso por SSH y los secretos se gestionan de forma segura;
  • se responden las preguntas de la práctica vinculadas a los CE 6.a–6.h.

La parte opcional añade como evidencia el enlace público a GitHub Pages. No se deben incluir contraseñas, tokens ni claves privadas en el repositorio.

7. Presentaciones