CI/CD

Add config field for customizing the suffix on an ephemeral App #14441

Workflow file for this run

.github/workflows/ci-cd.yml at ebf1911

	name: CI/CD

	on:
	push:
	branches:
	- main
	pull_request:

	# Cancel previous runs of the same PR but do not cancel previous runs on main
	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

	env:
	TERM: linux
	TERMINFO: /etc/terminfo
	PYTHONIOENCODING: utf-8

	jobs:
	client-versioning:
	if: github.ref == 'refs/heads/main'
	name: Update changelog and client version
	concurrency: client-versioning
	runs-on: ubuntu-24.04
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	outputs:
	release-hash: ${{ steps.release-data.outputs.hash }}

	steps:
	- name: Generate token for Github PR Bot
	id: generate_token
	uses: tibdex/github-app-token@32691ba7c9e7063bd457bd8f2a5703138591fa58 # v1
	with:
	app_id: ${{ secrets.GH_PRBOT_APP_ID }}
	private_key: ${{ secrets.GH_PRBOT_APP_PRIVATE_KEY }}

	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
	with:
	token: ${{ steps.generate_token.outputs.token }}
	fetch-depth: 2 # Needed so that we can check whether the version file was modified

	- uses: ./.github/actions/setup-cached-python
	with:
	version: "3.10"

	- name: Update the version
	run: inv bump-dev-version

	- name: Update the changelog
	run: inv update-changelog --sha=$GITHUB_SHA

	- name: Get release tag
	id: tag
	run: echo "release_tag=`inv get-release-tag`" >> "$GITHUB_OUTPUT"

	- uses: EndBug/add-and-commit@a94899bca583c204427a224a7af87c02f9b325d5 # v9
	with:
	pull: "--rebase --autostash"
	add: modal_version/__init__.py CHANGELOG.md
	commit: "--allow-empty"
	message: "[auto-commit] [skip ci] Bump the build number"
	tag: ${{ steps.tag.outputs.release_tag }}
	default_author: github_actions

	- name: Get release hash
	id: release-data
	run: echo "hash=`git rev-parse HEAD`" >> "$GITHUB_OUTPUT"

	- name: Install the client
	run: \|
	inv protoc
	pip install .

	- name: Publish client mount
	env:
	MODAL_ENVIRONMENT: main
	MODAL_LOGLEVEL: DEBUG
	MODAL_TOKEN_ID: ${{ secrets.MODAL_TOKEN_ID }}
	MODAL_TOKEN_SECRET: ${{ secrets.MODAL_TOKEN_SECRET }}
	run: python -m modal_global_objects.mounts.modal_client_package

	client-test:
	name: Unit tests on ${{ matrix.python-version }} and ${{ matrix.os }} (protobuf=${{ matrix.proto-version }})
	timeout-minutes: 30

	strategy:
	fail-fast: false # run all variants across python versions/os to completion
	matrix:
	python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
	os: ["ubuntu-24.04"]
	proto-version: ["latest"]
	include:
	- os: "macos-13" # x86-64
	python-version: "3.10"
	proto-version: "latest"
	- os: "macos-14" # ARM64 (M1)
	python-version: "3.10"
	proto-version: "latest"
	- os: "windows-latest"
	python-version: "3.10"
	proto-version: "latest"
	- os: "ubuntu-24.04"
	python-version: "3.9"
	proto-version: "3.19"

	runs-on: ${{ matrix.os }}
	steps:
	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3

	- uses: ./.github/actions/setup-cached-python
	with:
	version: ${{ matrix.python-version }}

	- if: matrix.proto-version != 'latest'
	name: Install protobuf
	run: pip install protobuf==${{ matrix.proto-version }}

	- name: Build protobuf
	run: inv protoc

	- name: Build client package (installs all dependencies)
	run: pip install -e .

	- name: Run client tests
	run: inv test

	- name: Run docstring tests
	if: github.event.pull_request.head.repo.fork == false
	env:
	MODAL_ENVIRONMENT: client-doc-tests
	MODAL_TOKEN_ID: ${{ secrets.MODAL_TOKEN_ID }}
	MODAL_TOKEN_SECRET: ${{ secrets.MODAL_TOKEN_SECRET }}
	run: pytest -v --markdown-docs -m markdown-docs modal

	container-dependencies:
	name: Check minimal container dependencies for ${{ matrix.python-version }} / ${{ matrix.image-builder-version }}
	runs-on: ubuntu-24.04
	timeout-minutes: 4
	strategy:
	matrix:
	include:
	- image-builder-version: "2024.04"
	python-version: "3.9"
	- image-builder-version: "2024.04"
	python-version: "3.12"
	- image-builder-version: "2024.10"
	python-version: "3.9"
	- image-builder-version: "2024.10"
	python-version: "3.13"
	- image-builder-version: "2025.06"
	python-version: "3.9"
	- image-builder-version: "2025.06"
	python-version: "3.13"

	steps:
	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3

	- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5
	with:
	python-version: ${{ matrix.python-version }}

	- name: Install dependencies
	run: \|
	pip install -r modal/builder/${{ matrix.image-builder-version }}.txt
	pip install synchronicity

	- name: Compile protos
	run: \|
	python -m venv venv
	source venv/bin/activate
	if [ "${{ matrix.python-version }}" == "3.9" ]; then
	pip install grpcio-tools==1.48.2 grpclib==0.4.7;
	elif [ "${{ matrix.python-version }}" == "3.12" ]; then
	pip install grpcio-tools==1.59.2 grpclib==0.4.7;
	elif [ "${{ matrix.python-version }}" == "3.13" ]; then
	pip install grpcio-tools==1.66.2 grpclib==0.4.7;
	fi
	python -m grpc_tools.protoc --python_out=. --grpclib_python_out=. --grpc_python_out=. -I . modal_proto/api.proto
	python -m grpc_tools.protoc --plugin=protoc-gen-modal-grpclib-python=protoc_plugin/plugin.py --modal-grpclib-python_out=. -I . modal_proto/api.proto
	deactivate

	- name: Check entrypoint import
	run: \|
	python -c 'import modal._container_entrypoint; import modal._runtime.asgi'
	if [ "${{ matrix.image-builder-version }}" == "2024.04" ]; then python -c 'import fastapi'; fi

	publish-client:
	name: Publish client package
	if: github.ref == 'refs/heads/main'
	needs: [client-versioning, client-test]
	runs-on: ubuntu-24.04
	concurrency: publish-client
	timeout-minutes: 5
	steps:
	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
	with:
	# Check out the commit that bumped the version, after the merge that triggered the workflow
	ref: ${{ needs.client-versioning.outputs.release-hash }}

	- uses: ./.github/actions/setup-cached-python
	with:
	# This is load-bearing because it determines the version of the protobuf compiler
	# used for the gencode, which should be the minimal version that we support.
	version: "3.10"

	- name: Build protobuf
	run: inv protoc

	- name: Install all dependencies
	run: pip install -e .

	- name: Build type stubs
	run: inv type-stubs

	- name: Install build
	run: pip install build

	- name: Build package distributions (wheel and source)
	run: \|
	python -m build

	- name: Upload to PyPI
	env:
	TWINE_USERNAME: __token__
	TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
	run: twine upload dist/* --non-interactive

	publish-python-standalone:
	name: Publish Python standalone mounts
	if: github.ref == 'refs/heads/main'
	needs: [client-versioning, client-test, publish-client]
	runs-on: ubuntu-24.04
	timeout-minutes: 5
	env:
	MODAL_LOGLEVEL: DEBUG
	MODAL_TOKEN_ID: ${{ secrets.MODAL_TOKEN_ID }}
	MODAL_TOKEN_SECRET: ${{ secrets.MODAL_TOKEN_SECRET }}

	steps:
	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
	with:
	# Check out the commit that bumped the version, after the merge that triggered the workflow
	ref: ${{ needs.client-versioning.outputs.release-hash }}

	- uses: ./.github/actions/setup-cached-python
	with:
	version: "3.11"

	- name: Build protobuf
	run: inv protoc

	- name: Build client package (installs all dependencies)
	run: pip install -e .

	- name: Publish mounts
	run: python -m modal_global_objects.mounts.python_standalone

	publish-client-dependency-mounts:
	name: Publish client dependency mounts
	if: github.ref == 'refs/heads/main'
	needs: [client-versioning, client-test, publish-client]
	runs-on: ubuntu-24.04
	timeout-minutes: 5
	env:
	MODAL_LOGLEVEL: DEBUG
	MODAL_TOKEN_ID: ${{ secrets.MODAL_TOKEN_ID }}
	MODAL_TOKEN_SECRET: ${{ secrets.MODAL_TOKEN_SECRET }}

	steps:
	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
	with:
	# Check out the commit that bumped the version, after the merge that triggered the workflow
	ref: ${{ needs.client-versioning.outputs.release-hash }}

	- uses: ./.github/actions/setup-cached-python
	with:
	version: "3.11"

	- name: Build protobuf
	run: inv protoc

	- name: Build client package (installs all dependencies)
	run: pip install -e .

	- name: Install uv
	run: pip install uv

	- name: Publish mounts
	run: python -m modal_global_objects.mounts.modal_client_dependencies

	publish-base-images:
	name: \|
	Publish base images for ${{ matrix.image-name }} ${{ matrix.image-builder-version }}
	if: github.ref == 'refs/heads/main'
	needs: [client-versioning, client-test, publish-client]
	runs-on: ubuntu-24.04
	timeout-minutes: 5
	env:
	MODAL_LOGLEVEL: DEBUG
	MODAL_TOKEN_ID: ${{ secrets.MODAL_TOKEN_ID }}
	MODAL_TOKEN_SECRET: ${{ secrets.MODAL_TOKEN_SECRET }}
	strategy:
	matrix:
	image-builder-version: ["2023.12", "2024.04", "2024.10", "2025.06"]
	image-name: ["debian_slim", "micromamba"]

	steps:
	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
	with:
	# Check out the commit that bumped the version, after the merge that triggered the workflow
	ref: ${{ needs.client-versioning.outputs.release-hash }}

	- uses: ./.github/actions/setup-cached-python
	with:
	version: "3.11"

	- name: Build protobuf
	run: inv protoc

	- name: Build client package (installs all dependencies)
	run: pip install -e .

	- name: Set the Modal environment
	run: modal config set-environment main

	- name: Publish base images
	run: inv publish-base-images ${{ matrix.image-name }}
	--builder-version ${{ matrix.image-builder-version }}
	--allow-global-deployment --no-confirm

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add config field for customizing the suffix on an ephemeral App #14441

Workflow file

Add config field for customizing the suffix on an ephemeral App #14441

Uh oh!

Jobs

Run details

Workflow file for this run