#427: optimize nightly builds

.github/workflows/check-for-updates.yml

@@ -0,0 +1,34 @@
+name: Check for Updates
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 2 * * *'
+
+jobs:
+  verify_commit:
+    runs-on: ubuntu-latest
+    outputs:
+      RUN_BUILD: ${{ steps.verify_commit.outputs.RUN_BUILD }}
+    steps:
+      - uses: actions/checkout@v3
+      - id: verify_commit
+        run: |
+          if git log --since='24 hours ago' --oneline | grep '.'; then
+            echo "::set-output name=RUN_BUILD::true"
+          else
+            echo "::set-output name=RUN_BUILD::false"
+          fi
+
+  trigger_build:
+    runs-on: ubuntu-latest
+    needs: verify_commit
+    if: ${{ needs.verify_commit.outputs.RUN_BUILD == 'true' }}
+    steps:
+      - name: Trigger Nightly Build Workflow
+        run: |
+          curl -X POST \
+            -H "Accept: application/vnd.github.v3+json" \
+            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+            https://api.github.com/repos/${{ github.repository }}/actions/workflows/nightly-build.yml/dispatches \
+            -d '{"ref":"main"}'

.github/workflows/nightly-build.yml

@@ -17,11 +17,37 @@ jobs:
         if: ${{ (github.event_name == 'schedule') || (github.event_name == 'workflow_dispatch') }}
         run: echo '::set-output name=RUN_BUILD::'$(test -n "$(git log --format=%H --since='24 hours ago')" && echo 'true' || echo 'false')
 
+  # Builds documentation pdf file in cli/target/package and uploads artifact to docs
+  build-documentation:
+    name: Build documentation
+    needs: [ verify_commit ]
+    if: ${{ needs.verify_commit.outputs.RUN_BUILD == 'true' }}
+    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: |
+          cd documentation
+          mvn -B -ntp -Dstyle.color=always -DskipTests=true package
+      - name: Upload documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: documentation/target/generated-docs/*.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
-    runs-on: ${{ matrix.os }}
-    needs: verify_commit
+    needs: [ verify_commit, build-documentation ]
     if: ${{ needs.verify_commit.outputs.RUN_BUILD == 'true' }}
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ windows-latest, ubuntu-latest, macos-latest, macos-13 ]
@@ -36,19 +62,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: |
           cd cli
-          mvn -B -ntp -Pnative -P!include-docs -DskipTests=true package
-      - uses: actions/upload-artifact@v3
+          mvn -B -ntp -Dideasy.assembly.id=${{ matrix.os }} -Pnative -DskipTests=true package
+      - name: Upload native image
+        uses: actions/upload-artifact@v4
         with:
-          name: natives
+          name: natives-${{ matrix.os }}
           path: cli/target/*.tar.gz
 
-  build:
+  # Downloads all native image artifacts to cli/target and builds the project for deployment to OSSRH Nexus
+  deploy:
     name: Build Project and Deploy
-    needs: [ build-natives, verify_commit ]
+    needs: [ verify_commit, build-documentation, build-natives ]
     if: ${{ needs.verify_commit.outputs.RUN_BUILD == 'true' }}
     runs-on: ubuntu-latest
     steps:
@@ -60,16 +93,19 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: '17'
-      - uses: actions/download-artifact@v3
-      - name: Make natives available and build project
-        run: |
+      - name: Download natives and build project
+        uses: actions/download-artifact@v4
+        with:
+          pattern: natives-*
+          path: ./cli/target/
+          merge-multiple: true
+      - run: |
           mvn -B -ntp -Dstyle.color=always install
-          mv ./natives/* ./cli/target/
       - name: Deploy to OSSRH nexus
         env:
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
-        run: mvn --settings .mvn/settings.xml -DskipTests=true -Darchetype.test.skip=true -Dmaven.install.skip=true -Dgpg.skip=true -Dstyle.color=always -B -ntp -P deploy deploy
+        run: mvn --settings .mvn/settings.xml -DskipTests=true -Darchetype.test.skip=true -Dmaven.install.skip=true -Dgpg.skip=true -Dstyle.color=always -B -ntp -Pdeploy deploy
 
   check_status:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -5,12 +5,39 @@ 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: |
+          cd documentation
+          mvn -B -ntp -Dstyle.color=always -DskipTests=true package
+      - name: Upload documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: documentation/target/generated-docs/*.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 +48,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 -Dideasy.assembly.id=${{ matrix.os }} -Pnative -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 +82,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

@@ -15,8 +15,8 @@
   <properties>
     <mainClass>com.devonfw.tools.ide.cli.Ideasy</mainClass>
     <imageName>ideasy</imageName>
-    <releaseName>${project.artifactId}-${os.detected.name}-${os.detected.arch}</releaseName>
-    <native.maven.plugin.version>0.9.28</native.maven.plugin.version>
+    <native.maven.plugin.version>0.10.2</native.maven.plugin.version>
+    <assembly.maven.plugin.version>3.7.1</assembly.maven.plugin.version>
     <jline.version>3.24.1</jline.version>
     <jansi.version>2.4.0</jansi.version>
   </properties>
@@ -140,52 +140,9 @@
     </plugins>
   </build>
 
+
   <profiles>
-    <profile>
-      <id>deploy</id>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.codehaus.mojo</groupId>
-            <artifactId>build-helper-maven-plugin</artifactId>
-            <version>3.4.0</version>
-            <executions>
-              <execution>
-                <id>attach-artifacts</id>
-                <phase>package</phase>
-                <goals>
-                  <goal>attach-artifact</goal>
-                </goals>
-                <configuration>
-                  <artifacts>
-                    <artifact>
-                      <file>${project.build.directory}/${project.artifactId}-linux-x86_64.tar.gz</file>
-                      <type>tar.gz</type>
-                      <classifier>linux-x64</classifier>
-                    </artifact>
-                    <artifact>
-                      <file>${project.build.directory}/${project.artifactId}-windows-x86_64.tar.gz</file>
-                      <type>tar.gz</type>
-                      <classifier>windows-x64</classifier>
-                    </artifact>
-                    <artifact>
-                      <file>${project.build.directory}/${project.artifactId}-osx-x86_64.tar.gz</file>
-                      <type>tar.gz</type>
-                      <classifier>mac-x64</classifier>
-                    </artifact>
-                    <artifact>
-                      <file>${project.build.directory}/${project.artifactId}-osx-aarch_64.tar.gz</file>
-                      <type>tar.gz</type>
-                      <classifier>mac-arm</classifier>
-                    </artifact>
-                  </artifacts>
-                </configuration>
-              </execution>
-            </executions>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
+    <!-- Builds the native image and archives it with the documentation from the github artifact -->
     <profile>
       <id>native</id>
       <build>
@@ -230,6 +187,7 @@
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-assembly-plugin</artifactId>
+            <version>${assembly.maven.plugin.version}</version>
             <executions>
               <execution>
                 <id>create-distribution</id>
@@ -238,67 +196,60 @@
                   <goal>single</goal>
                 </goals>
                 <configuration>
-                  <finalName>${releaseName}</finalName>
-                  <appendAssemblyId>false</appendAssemblyId>
+                  <appendAssemblyId>true</appendAssemblyId>
                   <descriptors>
-                    <descriptor>/src/main/assembly/release.xml</descriptor>
+                    <descriptor>/src/main/assembly/release-${ideasy.assembly.id}.xml</descriptor>
                   </descriptors>
                 </configuration>
               </execution>
             </executions>
           </plugin>
-          <plugin>
-            <groupId>kr.motd.maven</groupId>
-            <artifactId>os-maven-plugin</artifactId>
-            <version>1.7.1</version>
-            <executions>
-              <execution>
-                <phase>initialize</phase>
-                <goals>
-                  <goal>detect</goal>
-                </goals>
-              </execution>
-            </executions>
-          </plugin>
         </plugins>
       </build>
     </profile>
 
-    <!-- New profile for including documentation -->
+    <!-- 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>include-docs</id>
-      <activation>
-        <activeByDefault>true</activeByDefault>
-      </activation>
+      <id>deploy</id>
       <build>
         <plugins>
           <plugin>
-            <!-- Include documentation into release -->
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-dependency-plugin</artifactId>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>build-helper-maven-plugin</artifactId>
+            <version>3.4.0</version>
             <executions>
               <execution>
-                <id>copy-documentation</id>
-                <phase>prepare-package</phase>
+                <id>attach-artifacts</id>
+                <phase>package</phase>
                 <goals>
-                  <goal>copy</goal>
+                  <goal>attach-artifact</goal>
                 </goals>
+                <configuration>
+                  <artifacts>
+                    <artifact>
+                      <file>${project.build.directory}/${project.artifactId}-${revision}-windows_x86_64.tar.gz</file>
+                      <type>tar.gz</type>
+                      <classifier>windows-x64</classifier>
+                    </artifact>
+                    <artifact>
+                      <file>${project.build.directory}/${project.artifactId}-${revision}-linux_x86_64.tar.gz</file>
+                      <type>tar.gz</type>
+                      <classifier>linux-x64</classifier>
+                    </artifact>
+                    <artifact>
+                      <file>${project.build.directory}/${project.artifactId}-${revision}-osx_x86_64.tar.gz</file>
+                      <type>tar.gz</type>
+                      <classifier>mac-x64</classifier>
+                    </artifact>
+                    <artifact>
+                      <file>${project.build.directory}/${project.artifactId}-${revision}-osx_aarch_64.tar.gz</file>
+                      <type>tar.gz</type>
+                      <classifier>mac-arm</classifier>
+                    </artifact>
+                  </artifacts>
+                </configuration>
               </execution>
             </executions>
-            <configuration>
-              <artifactItems>
-                <artifactItem>
-                  <groupId>${project.groupId}</groupId>
-                  <artifactId>ide-doc</artifactId>
-                  <version>${project.version}</version>
-                  <type>pdf</type>
-                  <destFileName>IDEasy-documentation.pdf</destFileName>
-                </artifactItem>
-              </artifactItems>
-              <outputDirectory>${project.build.directory}/package</outputDirectory>
-              <overWriteReleases>false</overWriteReleases>
-              <overWriteSnapshots>true</overWriteSnapshots>
-            </configuration>
           </plugin>
         </plugins>
       </build>