feat: optimize skip_push and skip_retag

Author: puehringer

.github/workflows/build-docker-artifacts.yml

@@ -102,23 +102,40 @@ jobs:
 
             const builds = process.env.BUILDS ? process.env.BUILDS.split(',') : Object.keys(config.build);
             const push_to = process.env.PUSH_TO ? process.env.PUSH_TO.split(',') : Object.keys(config.push || {});
+            const skip_push = process.env.SKIP_PUSH === 'true';
 
             const flavors = builds.map(id => [id, config.build[id]]).filter(([id, flavor]) => flavor.skip !== true).map(([id, flavor]) => {
+              const hooksDirectory = path.join('./deploy/build', flavor.directory, 'hooks');
+              const testImagesHookScript = path.join(hooksDirectory, 'test-images.sh');
+              const testImagesHookReport = path.join(hooksDirectory, 'test-images-report');
+              const testImageEnabled = fs.existsSync(testImagesHookScript);
+
               return {
                 ...flavor,
                 id,
+                // We can skip the push only if we don't want to test the image below
+                skip_push: skip_push && !testImageEnabled,
+                skip_retag: skip_push,
                 // Add metadata to the flavor object (will be used as matrix input)
                 build_time: buildTime,
                 image_tag: imageTag,
                 image_tag_branch_name: imageTagBranchName,
                 ecr_respositories: flavor.components.map(component => component.ecr_repository),
+                test_images: {
+                  enabled: testImageEnabled,
+                  script_path: testImagesHookScript,
+                  report_path: testImagesHookReport,
+                },
                 components: flavor.components.map(component => {
                   // Format build arguments as build-args string
                   const formattedBuildArgs = component.build_args ?
                     Object.entries(component.build_args).map(([key, value]) => `${key}=${value}`).join('\n') : '';
 
                   return {
                     ...component,
+                    // We can skip the push only if we don't want to test the image below
+                    skip_push: skip_push && !testImageEnabled,
+                    skip_retag: skip_push,
                     // Add metadata to the component object (will be used as matrix input),
                     flavor,
                     flavor_id: id,
@@ -143,6 +160,7 @@ jobs:
             console.log(result);
             return result;
         env:
+          SKIP_PUSH: ${{ inputs.skip_push }}
           BUILDS: ${{ inputs.builds }}
           PUSH_TO: ${{ inputs.push_to }}
 
@@ -282,6 +300,7 @@ jobs:
         continue-on-error: false
 
       - name: Push image
+        if: ${{ matrix.component.skip_push != true }}
         # Instead of the docker/build-push-action@v6 which will rebuild the image, just push it directly
         run: docker push ${{ matrix.component.image_ref }}
 
@@ -292,6 +311,7 @@ jobs:
   test-images:
     name: Test images of flavor ${{ matrix.flavor.id || 'default' }}
     needs: [get-flavors, build-flavors]
+    if: ${{ matrix.flavor.test_images.enabled == true }}
     strategy:
       fail-fast: false
       matrix:
@@ -304,13 +324,6 @@ jobs:
           ref: ${{ inputs.branch || github.sha }}
           token: ${{ secrets.CHECKOUT_TOKEN || github.event.repository.private == true && secrets.DATAVISYN_BOT_REPO_TOKEN || github.token }}
 
-      - name: Checkout github-workflows repository
-        uses: actions/checkout@v5
-        with:
-          repository: datavisyn/github-workflows
-          ref: ${{ env.WORKFLOW_BRANCH }}
-          path: ./tmp/github-workflows
-
       - name: Configure AWS Credentials
         uses: aws-actions/[email protected]
         with:
@@ -325,9 +338,8 @@ jobs:
         shell: bash
         id: test-images
         run: |
-          hooks_folder="$(realpath -m "./deploy/build/${{ matrix.flavor.directory }}/hooks")"
-          test_images_hook="$hooks_folder/test-images.sh"
-          test_images_report="$hooks_folder/test-images-report"
+          test_images_hook=$(jq -r '.test_images.script_path' <<< "$FLAVOR")
+          test_images_report=$(jq -r '.test_images.report_path' <<< "$FLAVOR")
 
           if [[ -f "$test_images_hook" ]]; then
             # Iterate through all components and store their image ref in an environment variable
@@ -369,7 +381,8 @@ jobs:
   retag-images:
     name: Retag images of flavor ${{ matrix.flavor.id || 'default' }}
     needs: [get-flavors, test-images]
-    if: ${{ inputs.skip_push != true }}
+    # As test-images may be skipped, we need this if to ensure this job runs: https://github.com/actions/runner/issues/491#issuecomment-1507495166
+    if: ${{ always() && !cancelled() && !failure() && matrix.flavor.skip_retag != true }}
     strategy:
       fail-fast: false
       matrix:
@@ -429,7 +442,7 @@ jobs:
   push-to-repositories:
     name: Push images to push targets
     # if? When should we do this? Always? Only for certain branches? If so, how should we define that, in the config.json?
-    if: ${{ inputs.skip_push != true && fromJson(needs.get-flavors.outputs.result).push_to != '' }}
+    if: ${{ fromJson(needs.get-flavors.outputs.result).push_to != '' }}
     needs: [retag-images, get-flavors]
     uses: datavisyn/github-workflows/.github/workflows/build-docker-artifacts-trigger-push.yml@main
     secrets: inherit