devonfw#427: added comments updated release

added comments to cli/pom.xml profiles
added changes of nightly build workflow to release workflow

Author: jan-vcapgemini

.github/workflows/release.yml

@@ -5,12 +5,38 @@ on:
   workflow_dispatch
 
 jobs:
+
+  # Builds documentation pdf file in cli/target/package and uploads artifact to docs
+  build-documentation:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Set up JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: '17'
+      - name: Make documentation available
+        run: |
+          mvn -B -Pbuild-documentation -Dstyle.color=always -DskipTests=true package
+      - name: Upload documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: cli/target/package/*.pdf
+
+  # Downloads documentation docs artifact, builds all native images, archives native image for each os with documentation pdf file and uploads artifacts to f.e. natives-windows-latest
   build-natives:
     name: Build native images
+    needs: build-documentation
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ windows-latest, macos-latest, macos-13, ubuntu-latest ]
+        os: [ windows-latest, ubuntu-latest, macos-latest, macos-13 ]
+
     steps:
       - uses: actions/checkout@v3
         with:
@@ -21,23 +47,26 @@ jobs:
           distribution: 'graalvm'
           github-token: ${{ secrets.GITHUB_TOKEN }}
           native-image-job-reports: 'true'
-      - name: Build native images with nativ maven plugin and extract in tar.gz
+      - name: Download documentation
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: ./cli/target/package
+      - name: Build native image
         shell: bash
         run: |
-          maven_config="$(cat .mvn/maven.config)"
-          current_version="${maven_config/#*-Drevision=}"
-          current_version="${current_version/ */}"
           cd cli
-          mvn -B -ntp -Pnative -DskipTests=true package
-      - uses: actions/upload-artifact@v3
+          mvn -B -ntp -P${{ matrix.os }} '-P!build-documentation' -DskipTests=true package
+      - name: Upload native image
+        uses: actions/upload-artifact@v4
         with:
-          name: natives
+          name: natives-${{ matrix.os }}
           path: cli/target/*.tar.gz
 
   release:
     name: Release on Sonatype OSS
     runs-on: ubuntu-latest
-    needs: [ build-natives ]
+    needs: [ build-documentation, build-natives ]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -52,7 +81,12 @@ jobs:
           cache: 'maven'
           gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: GPG_PASSPHRASE # env variable for GPG private key passphrase
-      - uses: actions/download-artifact@v3
+      - name: Download natives and build project
+        uses: actions/download-artifact@v4
+        with:
+          pattern: natives-*
+          path: ./cli/target/
+          merge-multiple: true
       - name: Publish to Apache Maven Central
         run: |
           maven_config="$(cat .mvn/maven.config)"

cli/pom.xml

@@ -142,7 +142,7 @@
 
 
   <profiles>
-
+    <!-- Builds the windows x86_64 native image and archives it with the documentation from the github artifact -->
     <profile>
       <id>windows-latest</id>
       <build>
@@ -207,7 +207,7 @@
         </plugins>
       </build>
     </profile>
-
+    <!-- Builds the linux x86_64 native image and archives it with the documentation from the github artifact -->
     <profile>
       <id>ubuntu-latest</id>
       <build>
@@ -272,7 +272,7 @@
         </plugins>
       </build>
     </profile>
-
+    <!-- Builds the osx x86_64 native image and archives it with the documentation from the github artifact -->
     <profile>
       <id>macos-13</id>
       <build>
@@ -337,7 +337,7 @@
         </plugins>
       </build>
     </profile>
-
+    <!-- Builds the osx aarch_64 native image and archives it with the documentation from the github artifact -->
     <profile>
       <id>macos-latest</id>
       <build>
@@ -403,7 +403,7 @@
       </build>
     </profile>
 
-    <!-- New profile for including documentation -->
+    <!-- Builds the documentation pdf file and stores it in target/package -->
     <profile>
       <id>build-documentation</id>
       <build>
@@ -440,6 +440,7 @@
       </build>
     </profile>
 
+    <!-- Attaches artifacts stored in cli/target/*.tgz to the maven build, moves them to documentation/target/nexus-staging/.../*.tgz and deploys them with the name defined in the classifier -->
     <profile>
       <id>deploy</id>
       <build>