Trigger unit tests for docker images upload workflow

xibinliu · xibinliu · commit ffd00f3aafe9 · 2026-03-06T21:29:59.000Z
- images will only be tagged to the current date when unit tests pass
- images will only be tagged to "latest" when unit tests pass
diff --git a/.github/workflows/UploadDockerImages.yml b/.github/workflows/UploadDockerImages.yml
@@ -15,7 +15,7 @@
 # This workflow builds and pushes MaxText images for both TPU and GPU devices.
 # It runs automatically daily at 12am UTC, on Pull Requests, or manually via Workflow Dispatch.
 
-name: Build Images
+name: Build and Test Images
 
 on:
   schedule:
@@ -32,6 +32,11 @@ on:
           - all
           - tpu
           - gpu
+      for_dev_test:
+        description: 'For development test purpose. All images will be added a -test suffix'
+        required: false
+        type: boolean
+        default: false
 
 permissions:
   contents: read
@@ -42,6 +47,7 @@ jobs:
     outputs:
       maxtext_sha: ${{ steps.vars.outputs.maxtext_sha }}
       image_date: ${{ steps.vars.outputs.image_date }}
+      image_suffix: ${{ steps.vars.outputs.image_suffix }}
     steps:
      - name: Checkout MaxText
        uses: actions/checkout@v5
@@ -55,6 +61,13 @@ jobs:
         # Image date
         echo "image_date=$(date +%Y-%m-%d)" >> $GITHUB_OUTPUT
 
+        # If for_dev_test is true, set suffix to -test, otherwise empty
+        if [[ "${{ github.event.inputs.for_dev_test }}" == "true" ]]; then
+          echo "image_suffix=-test" >> $GITHUB_OUTPUT
+        else
+          echo "image_suffix=" >> $GITHUB_OUTPUT
+        fi
+
   tpu-pre-training:
     name: ${{ matrix.image_name }}
     needs: setup
@@ -72,7 +85,7 @@ jobs:
             dockerfile: ./dependencies/dockerfiles/maxtext_tpu_dependencies.Dockerfile
     uses: ./.github/workflows/build_and_push_docker_image.yml
     with:
-      image_name: ${{ matrix.image_name }}
+      image_name: ${{ matrix.image_name }}${{ needs.setup.outputs.image_suffix  }}
       device: ${{ matrix.device }}
       build_mode: ${{ matrix.build_mode }}
       dockerfile: ${{ matrix.dockerfile }}
@@ -84,7 +97,7 @@ jobs:
     needs: setup
     uses: ./.github/workflows/build_and_push_docker_image.yml
     with:
-      image_name: maxtext_post_training_stable
+      image_name: maxtext_post_training_stable${{ needs.setup.outputs.image_suffix  }}
       device: tpu
       build_mode: stable
       workflow: post-training
@@ -97,14 +110,14 @@ jobs:
     needs: [setup, tpu-post-training-stable]
     uses: ./.github/workflows/build_and_push_docker_image.yml
     with:
-      image_name: maxtext_post_training_nightly
+      image_name: maxtext_post_training_nightly${{ needs.setup.outputs.image_suffix  }}
       device: tpu
       build_mode: nightly
       workflow: post-training
       dockerfile: ./dependencies/dockerfiles/maxtext_post_training_local_dependencies.Dockerfile
       maxtext_sha: ${{ needs.setup.outputs.maxtext_sha }}
       image_date: ${{ needs.setup.outputs.image_date }}
-      base_image: gcr.io/tpu-prod-env-multipod/maxtext_post_training_stable:${{ needs.setup.outputs.image_date }}
+      base_image: gcr.io/tpu-prod-env-multipod/maxtext_post_training_stable${{ needs.setup.outputs.image_suffix  }}:${{ needs.setup.outputs.image_date }}-build-${{ github.run_id }}
 
   gpu-pre-training:
     name: ${{ matrix.image_name }}
@@ -123,9 +136,54 @@ jobs:
             dockerfile: ./dependencies/dockerfiles/maxtext_gpu_dependencies.Dockerfile
     uses: ./.github/workflows/build_and_push_docker_image.yml
     with:
-      image_name: ${{ matrix.image_name }}
+      image_name: ${{ matrix.image_name }}${{ needs.setup.outputs.image_suffix  }}
       device: ${{ matrix.device }}
       build_mode: ${{ matrix.build_mode }}
       dockerfile: ${{ matrix.dockerfile }}
       maxtext_sha: ${{ needs.setup.outputs.maxtext_sha }}
       image_date: ${{ needs.setup.outputs.image_date }}
+
+  # TEST JOBS
+  pre-training-tpu-tests:
+    needs: [setup, tpu-pre-training]
+    strategy:
+      fail-fast: false
+      matrix:
+        image: [maxtext_jax_stable, maxtext_jax_nightly]
+    uses: ./.github/workflows/test_and_tag_docker_image.yml
+    with:
+      image_name: ${{ matrix.image }}${{ needs.setup.outputs.image_suffix  }}
+      image_date: ${{ needs.setup.outputs.image_date }}
+      test_mode: tpu-pre-training
+
+  post-training-tpu-stable-tests:
+    needs: [setup, tpu-post-training-stable]
+    strategy:
+      fail-fast: false
+    uses: ./.github/workflows/test_and_tag_docker_image.yml
+    with:
+      image_name: maxtext_post_training_stable${{ needs.setup.outputs.image_suffix  }}
+      image_date: ${{ needs.setup.outputs.image_date }}
+      test_mode: tpu-post-training
+
+  post-training-tpu-nightly-tests:
+    needs: [setup, tpu-post-training-nightly]
+    strategy:
+      fail-fast: false
+    uses: ./.github/workflows/test_and_tag_docker_image.yml
+    with:
+      image_name: maxtext_post_training_nightly${{ needs.setup.outputs.image_suffix  }}
+      image_date: ${{ needs.setup.outputs.image_date }}
+      test_mode: tpu-post-training
+
+  pre-training-gpu-tests:
+    needs: [setup, gpu-pre-training]
+    strategy:
+      fail-fast: false
+      matrix:
+        image: [maxtext_gpu_jax_stable, maxtext_gpu_jax_nightly]
+    uses: ./.github/workflows/test_and_tag_docker_image.yml
+    with:
+      image_name: ${{ matrix.image }}${{ needs.setup.outputs.image_suffix  }}
+      image_date: ${{ needs.setup.outputs.image_date }}
+      test_mode: gpu-pre-training
diff --git a/.github/workflows/build_and_push_docker_image.yml b/.github/workflows/build_and_push_docker_image.yml
@@ -41,10 +41,6 @@ on:
         required: false
         type: string
         default: ''
-      workflow:
-        required: false
-        type: string
-        default: 'pre-training'
 
 permissions:
   contents: read
@@ -87,7 +83,9 @@ jobs:
           ref: ${{ inputs.maxtext_sha }}
 
       - name: Checkout post-training dependencies
-        if: steps.check.outputs.should_run == 'true' && inputs.image_name == 'maxtext_post_training_nightly'
+        if: |
+          steps.check.outputs.should_run == 'true' &&
+          contains(inputs.image_name, 'post_training_nightly')
         run: |
           git clone https://github.com/google/tunix.git ./tunix
           git clone https://github.com/vllm-project/vllm.git ./vllm
@@ -115,7 +113,7 @@ jobs:
           push: true
           context: .
           file: ${{ inputs.dockerfile }}
-          tags: gcr.io/tpu-prod-env-multipod/${{ inputs.image_name }}:latest
+          tags: gcr.io/tpu-prod-env-multipod/${{ inputs.image_name }}:${{ inputs.image_date }}-build-${{ github.run_id }}
           cache-from: type=gha
           outputs: type=image,compression=zstd,force-compression=true
           build-args: |
@@ -132,27 +130,22 @@ jobs:
         shell: bash
         run: |
           SOURCE_IMAGE="gcr.io/tpu-prod-env-multipod/${INPUTS_IMAGE_NAME}"
-
-          # Add date tag
-          gcloud container images add-tag "$SOURCE_IMAGE:latest" "$SOURCE_IMAGE:${INPUTS_IMAGE_DATE}" --quiet
+          TEMP_IMG="${SOURCE_IMAGE}:${INPUTS_IMAGE_DATE}-build-${{ github.run_id }}"
 
           # Convert date to YYYYMMDD format
           clean_date=$(echo "${INPUTS_IMAGE_DATE}" | sed 's/[-:]//g' | cut -c1-8)
 
           # Add MaxText tag
           maxtext_hash=$(git rev-parse --short HEAD)
-          gcloud container images add-tag "$SOURCE_IMAGE:latest" "$SOURCE_IMAGE:maxtext_${maxtext_hash}_${clean_date}" --quiet
-
+          gcloud container images add-tag "${TEMP_IMG}" "${SOURCE_IMAGE}:maxtext_${maxtext_hash}_${clean_date}" --quiet
 
           # Add post-training dependencies tags
-          if [ "${{ inputs.workflow }}" == "post-training" ]; then
-            for dir in tunix vllm tpu-inference; do
-              if [ -d "./$dir" ]; then
-                dir_hash=$(git -C "$dir" rev-parse --short HEAD)
-                gcloud container images add-tag "$SOURCE_IMAGE:latest" "$SOURCE_IMAGE:${dir}_${dir_hash}_${clean_date}" --quiet
-              fi
-            done
-          fi
+          for dir in tunix vllm tpu-inference; do
+            if [ -d "./$dir" ]; then
+              dir_hash=$(git -C "$dir" rev-parse --short HEAD)
+              gcloud container images add-tag "${TEMP_IMG}" "${SOURCE_IMAGE}:${dir}_${dir_hash}_${clean_date}" --quiet
+            fi
+          done
         env:
           INPUTS_IMAGE_NAME: ${{ inputs.image_name }}
           INPUTS_IMAGE_DATE: ${{ inputs.image_date }}
diff --git a/.github/workflows/test_and_tag_docker_image.yml b/.github/workflows/test_and_tag_docker_image.yml
@@ -0,0 +1,96 @@
+# Copyright 2025 Google LLC
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This workflow will test and tag MaxText Docker image to GCR.
+name: Test and Tag MaxText Docker Images
+
+on:
+  workflow_call:
+    inputs:
+      image_name:
+        required: true
+        type: string
+      test_mode:
+        description: "Test mode (tpu-pre-training, tpu-post-training, gpu-pre-training)"
+        required: true
+        type: string
+      image_date:
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        flavor: >-
+            ${{ fromJSON('{
+              "gpu-pre-training": ["gpu-unit", "gpu-integration"],
+              "tpu-post-training": ["post-training-tpu-unit", "post-training-tpu-integration"],
+              "tpu-pre-training": ["tpu-unit", "tpu-integration", "cpu-unit"]
+            }')[inputs.test_mode] }}
+    uses: ./.github/workflows/run_tests_coordinator.yml
+    with:
+      flavor: ${{ matrix.flavor }}
+      base_image: ${{ inputs.image_name }}:${{ inputs.image_date }}-build-${{ github.run_id }}
+      is_scheduled_run: true
+      maxtext_installed: true
+
+  notebook-test:
+    if: inputs.test_mode == 'tpu-post-training'
+    uses: ./.github/workflows/run_jupyter_notebooks.yml
+    with:
+      device_type: tpu
+      device_name: v6e-4
+      base_image: ${{ inputs.image_name }}:${{ inputs.image_date }}-build-${{ github.run_id }}
+      cloud_runner: linux-x86-ct6e-180-4tpu
+      maxtext_installed: true
+    secrets:
+      HF_TOKEN: ${{ secrets.HF_TOKEN }}
+
+  tagging:
+    needs: [test, notebook-test]
+    if: |
+      always() &&
+      needs.test.result == 'success' &&
+      (needs.notebook-test.result == 'success' || needs.notebook-test.result == 'skipped')
+    runs-on: linux-x86-n2-16-buildkit
+    container: google/cloud-sdk:524.0.0
+    steps:
+      - name: Configure Docker
+        run: gcloud auth configure-docker us-docker.pkg.dev,gcr.io -q
+
+      - name: Create Production Tags
+        shell: bash
+        env:
+          INPUTS_IMAGE_NAME: ${{ inputs.image_name }}
+          INPUTS_IMAGE_DATE: ${{ inputs.image_date }}
+        run: |
+          SOURCE_IMAGE="gcr.io/tpu-prod-env-multipod/${INPUTS_IMAGE_NAME}"
+          TEMP_IMG="${SOURCE_IMAGE}:${INPUTS_IMAGE_DATE}-build-${{ github.run_id }}"
+
+          # Validate existence first
+          gcloud container images describe "${TEMP_IMG}" > /dev/null
+
+          # 1. Date Tag
+          gcloud container images add-tag "${TEMP_IMG}" "${SOURCE_IMAGE}:${INPUTS_IMAGE_DATE}" --quiet
+
+          # 2. Latest Tag
+          gcloud container images add-tag "${TEMP_IMG}" "${SOURCE_IMAGE}:latest" --quiet
+
+          # 3. Clean up Temporary Tag
+          gcloud container images untag "${TEMP_IMG}" --quiet
