Este documento presenta una guía para los desarrolladores del proyecto.
Existen distintas maneras de configurar el ambiente de desarrollo:
Plantuml soporta un mecanísmo que facilita la generación y posterior mantenimiento de los diagramas de clase, secuencia, estado y paquetes. Para mayor información referir a la guía de PlantUML.
Cuando se genera un tag que comienza con v
(ejemplo v0.0.1
) automáticamente se produce un release con la aplicación empaquetada. Para el nombre de la versión se recomienda utilizar versionado semántico, por ejemplo:
$ git tag v0.0.1 # Genera el tag sobre el commit actual
$ git push --tags # Pushea el tag al repo, iniciando el release automático
Para más información sobre cómo generar tags ver la documentación de git.
El archivo .jar
generado en el release contiene la aplicación empaquetada y puede distribuirse. Luego puede ejecutarse en Windows, Mac o Linux con:
$ java -jar <archivo.jar>
Al pushear el código al repositorio este es analizado con CodeQL. Si se encuentra algún error o vulnerabilidad se mostrará en la pestaña Security -> Code scanning alerts. Luego de que dicho error sea arreglado la alerta se resuelve de forma automática, para más información consultar la documentación de github.