UploadDockerImages.yml

# Copyright 2023–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 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 and Test Images

on:
  schedule:
    # Run the job daily at 12AM UTC
    - cron: '0 0 * * *'
  workflow_dispatch:
    inputs:
      target_device:
        description: 'Specify target device (all, tpu, or gpu)'
        required: true
        type: choice
        default: 'all'
        options:
          - 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

jobs:
  setup:
    runs-on: ubuntu-latest
    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

     - name: Get metadata
       id: vars
       run: |
        # MaxText SHA
        echo "maxtext_sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT

        # 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
    strategy:
      fail-fast: false
      matrix:
        include:
          - device: tpu
            build_mode: stable
            image_name: maxtext_jax_stable
            dockerfile: ./src/dependencies/dockerfiles/maxtext_tpu_dependencies.Dockerfile
          - device: tpu
            build_mode: nightly
            image_name: maxtext_jax_nightly
            dockerfile: ./src/dependencies/dockerfiles/maxtext_tpu_dependencies.Dockerfile
    uses: ./.github/workflows/build_and_push_docker_image.yml
    with:
      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_mode: tpu-pre-training

  tpu-post-training-nightly:
    name: tpu-post-training-nightly
    needs: [setup]
    uses: ./.github/workflows/build_and_push_docker_image.yml
    with:
      image_name: maxtext_post_training_nightly${{ needs.setup.outputs.image_suffix  }}
      device: tpu
      build_mode: nightly
      workflow: post-training
      dockerfile: ./src/dependencies/dockerfiles/maxtext_tpu_dependencies.Dockerfile
      maxtext_sha: ${{ needs.setup.outputs.maxtext_sha }}
      image_date: ${{ needs.setup.outputs.image_date }}
      test_mode: tpu-post-training

  gpu-pre-training:
    name: ${{ matrix.image_name }}
    needs: setup
    strategy:
      fail-fast: false
      matrix:
        include:
          - device: gpu
            build_mode: stable
            image_name: maxtext_gpu_jax_stable
            dockerfile: ./src/dependencies/dockerfiles/maxtext_gpu_dependencies.Dockerfile
          - device: gpu
            build_mode: nightly
            image_name: maxtext_gpu_jax_nightly
            dockerfile: ./src/dependencies/dockerfiles/maxtext_gpu_dependencies.Dockerfile
    uses: ./.github/workflows/build_and_push_docker_image.yml
    with:
      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_mode: gpu-pre-training