Skip to content

Build Images

Build Images #961

# 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 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
image_suffix:
description: 'An image suffix can be provided to add to the image name'
required: false
type: string
default: ""
permissions:
contents: read
jobs:
setup:
runs-on: ubuntu-latest
outputs:
maxtext_sha: ${{ steps.vars.outputs.maxtext_sha }}
image_date: ${{ steps.vars.outputs.image_date }}
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
build-and-push:
name: ${{ matrix.image_name }}
needs: setup
strategy:
fail-fast: false
matrix:
include:
- device: tpu
build_mode: stable
workflow: pre-training
image_name: maxtext_jax_stable
dockerfile: ./src/dependencies/dockerfiles/maxtext_tpu_dependencies.Dockerfile
- device: tpu
build_mode: nightly
workflow: pre-training
image_name: maxtext_jax_nightly
dockerfile: ./src/dependencies/dockerfiles/maxtext_tpu_dependencies.Dockerfile
- device: tpu
build_mode: nightly
workflow: post-training
image_name: maxtext_post_training_nightly
dockerfile: ./src/dependencies/dockerfiles/maxtext_tpu_dependencies.Dockerfile
- device: gpu
build_mode: stable
workflow: pre-training
image_name: maxtext_gpu_jax_stable
dockerfile: ./src/dependencies/dockerfiles/maxtext_gpu_dependencies.Dockerfile
- device: gpu
build_mode: nightly
workflow: pre-training
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 }}${{ inputs.image_suffix }}
device: ${{ matrix.device }}
build_mode: ${{ matrix.build_mode }}
workflow: ${{ matrix.workflow }}
dockerfile: ${{ matrix.dockerfile }}
maxtext_sha: ${{ needs.setup.outputs.maxtext_sha }}
image_date: ${{ needs.setup.outputs.image_date }}
secrets:
HF_TOKEN: ${{ secrets.HF_TOKEN }}
promote:
name: promote-${{ matrix.image_name }}
needs: build-and-push
strategy:
fail-fast: false
matrix:
include:
- device: tpu
build_mode: stable
workflow: pre-training
image_name: maxtext_jax_stable
- device: tpu
build_mode: nightly
workflow: pre-training
image_name: maxtext_jax_nightly
- device: tpu
build_mode: nightly
workflow: post-training
image_name: maxtext_post_training_nightly
- device: gpu
build_mode: stable
workflow: pre-training
image_name: maxtext_gpu_jax_stable
- device: gpu
build_mode: nightly
workflow: pre-training
image_name: maxtext_gpu_jax_nightly
uses: ./.github/workflows/promote_docker_image.yml
with:
image_name: ${{ matrix.image_name }}${{ inputs.image_suffix }}
image_tag: ${{ github.run_id }}
device: ${{ matrix.device }}
workflow: ${{ matrix.workflow }}
secrets:
HF_TOKEN: ${{ secrets.HF_TOKEN }}