build

fix: dev-remote hmr port override #20675

Workflow file for this run

	name: build

	on:
	pull_request:
	types: [opened, synchronize]
	merge_group:
	types: [checks_requested]
	push:
	# Always run on push to main. The build cache can only be reused
	# if it was saved by a run from the repository's default branch.
	# The run result will be identical to that from the merge queue
	# because the commit is identical, yet we need to perform it to
	# seed the build cache.
	branches:
	- main
	schedule:
	- cron: '0 0,12 * * *' # Runs at 00:00 and 12:00 UTC daily

	env:
	GOTESTSUM_FORMAT: github-actions

	jobs:
	cleanups:
	runs-on:
	group: databricks-deco-testing-runner-group
	labels: ubuntu-latest-deco
	steps:
	- name: Clean up cache if running on schedule
	if: ${{ github.event_name == 'schedule' }}
	env:
	GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	run: gh cache delete --all --repo databricks/cli \|\| true

	testmask:
	runs-on: ubuntu-latest
	outputs:
	targets: ${{ steps.mask1.outputs.targets \|\| steps.mask2.outputs.targets \|\| steps.mask3.outputs.targets }}
	steps:
	- name: Checkout repository
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
	with:
	fetch-depth: 0

	- name: Setup Go
	uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0
	with:
	go-version-file: tools/go.mod

	- name: Run testmask (pull requests)
	if: ${{ github.event_name == 'pull_request' }}
	id: mask1
	working-directory: tools/testmask
	run: \|
	go run . ${{ github.event.pull_request.head.sha }} ${{ github.event.pull_request.base.sha }} \| tee output.json
	echo "targets=$(jq -c '.' output.json)" >> $GITHUB_OUTPUT

	- name: Run testmask (merge group)
	if: ${{ github.event_name == 'merge_group' }}
	id: mask2
	working-directory: tools/testmask
	run: \|
	go run . ${{ github.event.merge_group.head_sha }} ${{ github.event.merge_group.base_sha }} \| tee output.json
	echo "targets=$(jq -c '.' output.json)" >> $GITHUB_OUTPUT

	- name: Run testmask (other events)
	if: ${{ github.event_name != 'pull_request' && github.event_name != 'merge_group' }}
	id: mask3
	working-directory: tools/testmask
	run: \|
	# Always run all tests
	echo "targets=[\"test\"]" >> $GITHUB_OUTPUT

	test:
	needs:
	- cleanups
	- testmask

	# Only run if the target is in the list of targets from testmask
	if: ${{ contains(fromJSON(needs.testmask.outputs.targets), 'test') }}
	name: "make test (${{matrix.os.name}}, ${{matrix.deployment}})"
	runs-on: ${{ matrix.os.runner }}

	strategy:
	fail-fast: false
	matrix:
	# Use separate fields for the OS name and runner configuration.
	# When combined in a single object, "runs-on" errors with "Unexpected value 'name'".
	os:
	- name: linux
	runner:
	group: databricks-protected-runner-group-large
	labels: linux-ubuntu-latest-large

	- name: windows
	runner:
	group: databricks-protected-runner-group-large
	labels: windows-server-latest-large

	- name: macos
	runner:
	labels: macos-latest

	deployment:
	- "terraform"
	- "direct"

	# Include "event_name" in the matrix so we can include/exclude based on it.
	event:
	- ${{ github.event_name }}

	# Run on Linux only in merge queue to reduce time to merge.
	exclude:
	- event: merge_group
	os:
	name: windows
	- event: merge_group
	os:
	name: macos

	steps:
	- name: Checkout repository and submodules
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Setup build environment
	uses: ./.github/actions/setup-build-environment
	with:
	cache-key: test-${{ matrix.deployment }}

	- name: Run tests without coverage
	# We run tests without coverage on PR, merge_group, and schedule because we don't make use of coverage information
	# and would like to run the tests as fast as possible. We run it on schedule as well, because that is what
	# populates the cache and cache may include test results.
	if: ${{ github.event_name == 'pull_request' \|\| github.event_name == 'merge_group' \|\| github.event_name == 'schedule' }}
	env:
	ENVFILTER: DATABRICKS_BUNDLE_ENGINE=${{ matrix.deployment }}
	run: make test

	- name: Run tests with coverage
	# Only run 'make cover' on push to main to make sure it does not get broken.
	if: ${{ github.event_name == 'push' }}
	env:
	ENVFILTER: DATABRICKS_BUNDLE_ENGINE=${{ matrix.deployment }}
	run: make cover

	- name: Analyze slow tests
	run: make slowest

	test-exp-aitools:
	needs:
	- cleanups
	- testmask

	# Only run if the target is in the list of targets from testmask
	if: ${{ contains(fromJSON(needs.testmask.outputs.targets), 'test-exp-aitools') }}
	name: "make test-exp-aitools"
	runs-on: ${{ matrix.os }}

	strategy:
	fail-fast: false
	matrix:
	os:
	- macos-latest
	- ubuntu-latest
	- windows-latest

	steps:
	- name: Checkout repository and submodules
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Setup build environment
	uses: ./.github/actions/setup-build-environment
	with:
	cache-key: test-exp-aitools

	- name: Run tests
	run: \|
	make test-exp-aitools

	test-exp-apps-mcp:
	needs:
	- cleanups
	- testmask

	# Only run if the target is in the list of targets from testmask
	if: ${{ contains(fromJSON(needs.testmask.outputs.targets), 'test-exp-apps-mcp') }}
	name: "make test-exp-apps-mcp"
	runs-on: ${{ matrix.os }}

	strategy:
	fail-fast: false
	matrix:
	os:
	- macos-latest
	- ubuntu-latest
	# The Windows tests are broken; see https://github.com/databricks/cli/pull/4024.
	# - windows-latest

	steps:
	- name: Checkout repository and submodules
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Setup build environment
	uses: ./.github/actions/setup-build-environment
	with:
	cache-key: test-exp-apps-mcp

	- name: Run tests
	run: \|
	make test-exp-apps-mcp

	test-exp-ssh:
	needs:
	- cleanups
	- testmask

	# Only run if the target is in the list of targets from testmask
	if: ${{ contains(fromJSON(needs.testmask.outputs.targets), 'test-exp-ssh') }}
	name: "make test-exp-ssh"
	runs-on: ${{ matrix.os }}

	strategy:
	fail-fast: false
	matrix:
	os:
	- macos-latest
	- ubuntu-latest
	- windows-latest

	steps:
	- name: Checkout repository and submodules
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Setup build environment
	uses: ./.github/actions/setup-build-environment
	with:
	cache-key: test-exp-ssh

	- name: Run tests
	run: \|
	make test-exp-ssh

	test-pipelines:
	needs:
	- cleanups
	- testmask

	# Only run if the target is in the list of targets from testmask
	if: ${{ contains(fromJSON(needs.testmask.outputs.targets), 'test-pipelines') }}
	name: "make test-pipelines"
	runs-on: ${{ matrix.os }}

	strategy:
	fail-fast: false
	matrix:
	os:
	- macos-latest
	- ubuntu-latest
	- windows-latest

	steps:
	- name: Checkout repository and submodules
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Setup build environment
	uses: ./.github/actions/setup-build-environment
	with:
	cache-key: test-pipelines

	- name: Run tests
	run: \|
	make test-pipelines

	# This job groups the result of all the above test jobs.
	# It is a required check, so it blocks auto-merge and the merge queue.
	#
	# We use `if: always()` to ensure this job runs even when dependencies are skipped.
	# Without it, GitHub Actions skips jobs whose dependencies are skipped, which would
	# incorrectly block the merge queue when optional test jobs don't run.
	#
	# The step checks `contains(needs.*.result, 'failure')` to fail if any dependency failed.
	# Reference: https://github.com/orgs/community/discussions/25970
	test-result:
	needs:
	- test
	- test-exp-aitools
	- test-exp-apps-mcp
	- test-exp-ssh
	- test-pipelines

	if: ${{ always() }}
	name: test-result
	runs-on: ubuntu-latest

	steps:
	- run: \|
	if [[ "${{ contains(needs.*.result, 'failure') }}" == "true" ]]; then
	echo "One or more required jobs failed ❌"
	exit 1
	fi
	echo "All tests passed ✅"

	validate-generated-is-up-to-date:
	needs: cleanups
	runs-on: ubuntu-latest

	steps:
	- name: Checkout
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Setup Go
	uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0
	with:
	go-version-file: go.mod
	# Use different schema from regular job, to avoid overwriting the same key
	cache-dependency-path: \|
	go.sum
	bundle/internal/schema/.

	- name: Verify that the schema is up to date
	run: \|
	if ! ( make schema && git diff --exit-code ); then
	echo "The schema is not up to date. Please run 'make schema' and commit the changes."
	exit 1
	fi

	- name: Verify that the generated enum and required fields are up to date
	run: \|
	if ! ( make generate-validation && git diff --exit-code ); then
	echo "The generated enum and required fields are not up to date. Please run 'make generate-validation' and commit the changes."
	exit 1
	fi

	# Github repo: https://github.com/ajv-validator/ajv-cli
	- name: Install ajv-cli
	run: npm install -g [email protected]

	# Assert that the generated bundle schema is a valid JSON schema by using
	# ajv-cli to validate it against bundle configuration files.
	# By default the ajv-cli runs in strict mode which will fail if the schema
	# itself is not valid. Strict mode is more strict than the JSON schema
	# specification. See for details: https://ajv.js.org/options.html#strict-mode-options
	# The ajv-cli is configured to use the markdownDescription keyword which is not part of the JSON schema specification,
	# but is used in editors like VSCode to render markdown in the description field
	- name: Validate bundle schema
	run: \|
	go run main.go bundle schema > schema.json

	# Add markdownDescription keyword to ajv
	echo "module.exports = function(a) {
	a.addKeyword('deprecationMessage');
	a.addKeyword('doNotSuggest');
	a.addKeyword('markdownDescription');
	a.addKeyword('x-databricks-preview');
	}" >> keywords.js

	for file in ./bundle/internal/schema/testdata/pass/*.yml; do
	ajv test -s schema.json -d $file --valid -c=./keywords.js
	done

	for file in ./bundle/internal/schema/testdata/fail/*.yml; do
	ajv test -s schema.json -d $file --invalid -c=./keywords.js
	done

	validate-python-codegen:
	needs: cleanups
	runs-on: ubuntu-latest

	steps:
	- name: Checkout
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Install uv
	uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # v7.1.2
	with:
	version: "0.6.5"

	- name: Verify that python/codegen is up to date
	working-directory: python
	run: \|-
	make codegen

	if ! ( git diff --exit-code ); then
	echo "Generated Python code is not up-to-date. Please run 'pushd python && make codegen' and commit the changes."

	exit 1
	fi

	# Trigger integration tests in a separate repository.
	# Requires secrets from "test-trigger-is" environment (not available for fork PRs).
	# Auto-approves for merge groups to avoid running twice and queue timeouts.
	integration-trigger:
	needs:
	- testmask

	if: >-
	(github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork) \|\|
	(github.event_name == 'merge_group') \|\|
	(github.event_name == 'push')

	runs-on:
	group: databricks-deco-testing-runner-group
	labels: ubuntu-latest-deco

	environment: "test-trigger-is"

	steps:
	- name: Generate GitHub App Token
	if: ${{ github.event_name == 'pull_request' \|\| github.event_name == 'push' }}
	id: generate-token
	uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
	with:
	app-id: ${{ secrets.DECO_WORKFLOW_TRIGGER_APP_ID }}
	private-key: ${{ secrets.DECO_WORKFLOW_TRIGGER_PRIVATE_KEY }}
	owner: ${{ secrets.ORG_NAME }}
	repositories: ${{ secrets.REPO_NAME }}

	# Trigger integration tests if the primary "test" target is triggered by this change.
	- name: Trigger integration tests (pull request)
	if: ${{ github.event_name == 'pull_request' && contains(fromJSON(needs.testmask.outputs.targets), 'test') }}
	env:
	GH_TOKEN: ${{ steps.generate-token.outputs.token }}
	run: \|-
	gh workflow run cli-isolated-pr.yml -R ${{ secrets.ORG_NAME }}/${{ secrets.REPO_NAME }} \
	--ref main \
	-f pull_request_number=${{ github.event.pull_request.number }} \
	-f commit_sha=${{ github.event.pull_request.head.sha }}

	# Skip integration tests if the primary "test" target is not triggered by this change.
	- name: Skip integration tests (pull request)
	if: ${{ github.event_name == 'pull_request' && !contains(fromJSON(needs.testmask.outputs.targets), 'test') }}
	env:
	GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	run: \|-
	gh api -X POST -H "Accept: application/vnd.github+json" \
	-H "X-GitHub-Api-Version: 2022-11-28" \
	/repos/${{ github.repository }}/statuses/${{ github.event.pull_request.head.sha }} \
	-f 'state=success' \
	-f 'context=Integration Tests Check' \
	-f 'description=⏭️ Skipped'

	- name: Auto-approve for merge group
	if: ${{ github.event_name == 'merge_group' }}
	env:
	GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	run: \|-
	gh api -X POST -H "Accept: application/vnd.github+json" \
	-H "X-GitHub-Api-Version: 2022-11-28" \
	/repos/${{ github.repository }}/statuses/${{ github.sha }} \
	-f 'state=success' \
	-f 'context=Integration Tests Check' \
	-f 'description=⏭️ Skipped'

	- name: Trigger integration tests (push to main)
	if: ${{ github.event_name == 'push' }}
	env:
	GH_TOKEN: ${{ steps.generate-token.outputs.token }}
	run: \|-
	gh workflow run cli-isolated-nightly.yml -R ${{ secrets.ORG_NAME }}/${{ secrets.REPO_NAME }} \
	--ref main \
	-f commit_sha=${{ github.event.after }}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: dev-remote hmr port override #20675

Workflow file

fix: dev-remote hmr port override #20675

Uh oh!

Workflow file for this run