add documentation to work flow

Author: jsgiraldoh28

.github/workflows/maven.yml

@@ -11,16 +11,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+    # 📥 Obtener el código fuente del repositorio
     - name: Checkout repo
       uses: actions/checkout@v4
 
+    # ☕ Configurar JDK 17 y cachear dependencias de Maven  
     - name: Set up JDK 17
       uses: actions/setup-java@v4
       with:
         java-version: '17'
         distribution: 'temurin'
         cache: maven
 
+    # 🔨 Compilar y ejecutar pruebas con Maven
     - name: Build with Maven
       run: mvn -B -V -DskipTests=false verify
 
@@ -35,16 +38,19 @@ jobs:
     #      target/**
     #    if-no-files-found: warn
 
+    # 📦 Copiar el JAR generado al contexto de Docker
     - name: Copy JAR to docker context
       run: |
         mkdir -p dockerfile
         echo "Jar files in target:"
         ls -la target/*.jar || true
         cp target/*.jar dockerfile/ || true
 
+    # 🐳 Construir imagen Docker con el JAR
     - name: Build Docker image
       run: docker build -f dockerfile/Dockerfile -t my-app-image:${{ github.sha }} dockerfile/
 
+    # 🔍 Escanear vulnerabilidades de la imagen con Trivy
     - name: Scan Docker image with Trivy
       uses: aquasecurity/trivy-action@0.33.1
       continue-on-error: true
@@ -54,13 +60,15 @@ jobs:
         severity: CRITICAL,HIGH
         vuln-type: os,library
 
+    # 🔑 Autenticarse en GitHub Container Registry
     - name: Log in to GitHub Container Registry
       uses: docker/login-action@v2
       with:
         registry: ghcr.io
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
 
+    # 📤 Construir y publicar imagen en GHCR con dos tags (latest y commit SHA)
     - name: Build and push to GHCR
       uses: docker/build-push-action@v4
       with:
@@ -71,12 +79,15 @@ jobs:
           ghcr.io/${{ github.repository_owner }}/my-app-image:latest
           ghcr.io/${{ github.repository_owner }}/my-app-image:${{ github.sha }}
 
+    # 🚀 Desplegar contenedor localmente para pruebas rápidas
     - name: Deploy Docker container
       run: |
         docker run -d --name my-app-container -p 8080:8080 ghcr.io/jsgiraldoh/my-app-image:${{ github.sha }}
 
+    # 📜 Mostrar logs del contenedor en ejecución
     - name: Show Docker container logs
       run: docker logs -f my-app-container
 
+    # 🧹 Eliminar contenedor al finalizar
     - name: Remove Docker container
       run: docker container rm -f my-app-container

src/main/java/com/mycompany/app/App.java

@@ -5,7 +5,7 @@
  */
 public class App {
 
-    private static final String MESSAGE = "Hello World from Github Actions 3!";
+    private static final String MESSAGE = "Hello World from Github Actions!";
 
     public App() {}
 

src/test/java/com/mycompany/app/AppTest.java

@@ -20,6 +20,6 @@ public void testAppConstructor() {
     public void testAppMessage()
     {
         App app = new App();
-        assertEquals("Hello World from Github Actions 3!", app.getMessage());
+        assertEquals("Hello World from Github Actions!", app.getMessage());
     }
 }