Run pre-commit checks #25824

Workflow file for this run

.github/workflows/pre-commit.yml at 9610c3c

	name: Pre-commit

	run-name: Run pre-commit checks

	on:
	pull_request:
	merge_group:
	push:
	branches:
	- main
	- 'release-[0-9]+.[0-9]+.x'

	concurrency:
	group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.run_id \|\| github.ref }}
	cancel-in-progress: true

	jobs:
	pre-commit:
	runs-on: ubuntu-latest
	timeout-minutes: 15
	strategy:
	matrix:
	node-version: [22]
	permissions:
	contents: write
	pull-requests: write

	steps:
	- name: Checkout code
	uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
	with:
	# For dependabot PRs, we need to checkout with a token that can push changes
	token: ${{ github.actor == 'dependabot[bot]' && secrets.GITHUB_TOKEN \|\| github.token }}
	# Fetch enough history for api-conformance check (needs HEAD~1 for comparison)
	# Full history for dependabot PRs to allow commits
	fetch-depth: ${{ github.actor == 'dependabot[bot]' && 0 \|\| 2 }}

	- name: Set up Python
	uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
	with:
	python-version: '3.12'
	cache: pip
	cache-dependency-path: \|
	*/requirements.txt
	.pre-commit-config.yaml

	- name: Set up Node.js
	uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
	with:
	node-version: ${{matrix.node-version}}
	cache: 'npm'
	cache-dependency-path: 'src/ogx_ui/'

	- name: Set up uv
	uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0

	- name: Install npm dependencies
	run: npm ci
	working-directory: src/ogx_ui

	- name: Install pre-commit
	run: python -m pip install 'pre-commit>=4.4.0'

	- name: Cache pre-commit
	uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v4
	with:
	path: ~/.cache/pre-commit
	key: pre-commit-3\|${{ env.pythonLocation }}\|${{ hashFiles('.pre-commit-config.yaml') }}

	# Install oasdiff: https://github.com/oasdiff/oasdiff, a tool for detecting breaking changes in OpenAPI specs.
	# Pin the version to avoid CI/local drift in generated coverage files.
	- name: Install oasdiff
	env:
	OASDIFF_VERSION: "1.15.0"
	run: \|
	for i in 1 2 3; do
	curl -fsSL "https://github.com/oasdiff/oasdiff/releases/download/v${OASDIFF_VERSION}/oasdiff_${OASDIFF_VERSION}_linux_amd64.tar.gz" \
	\| tar xz -C /usr/local/bin oasdiff && break
	echo "Attempt $i failed, retrying in 10s..."
	sleep 10
	done
	cp /usr/local/bin/oasdiff ~/oasdiff

	- name: Run pre-commit
	id: precommit
	run: \|
	set +e
	pre-commit run --show-diff-on-failure --color=always --all-files 2>&1 \| tee /tmp/precommit.log
	status=${PIPESTATUS[0]}
	echo "status=$status" >> "$GITHUB_OUTPUT"
	exit 0
	env:
	SKIP: no-commit-to-branch,mypy
	RUFF_OUTPUT_FORMAT: github

	- name: Check pre-commit results
	if: steps.precommit.outputs.status != '0'
	run: \|
	echo "::error::Pre-commit hooks failed. Please run 'pre-commit run --all-files' locally and commit the fixes."
	echo ""
	echo "Failed hooks output:"
	cat /tmp/precommit.log
	exit 1

	- name: Debug
	run: \|
	echo "github.ref: ${{ github.ref }}"
	echo "github.actor: ${{ github.actor }}"

	- name: Commit changes for dependabot PRs
	if: github.actor == 'dependabot[bot]'
	env:
	HEAD_REF: ${{ github.head_ref }}
	run: \|
	if ! git diff --exit-code \|\| [ -n "$(git ls-files --others --exclude-standard)" ]; then
	git config --local user.email "github-actions[bot]@users.noreply.github.com"
	git config --local user.name "github-actions[bot]"

	# Ensure we're on the correct branch
	git checkout -B "$HEAD_REF"
	git add -A
	git commit -m "Apply pre-commit fixes"

	# Pull latest changes from the PR branch and rebase our commit on top
	git pull --rebase origin "$HEAD_REF"

	# Push to the PR branch
	git push origin "$HEAD_REF"
	echo "Pre-commit fixes committed and pushed"
	else
	echo "No changes to commit"
	fi

	- name: Verify no uncommitted changes
	if: github.actor != 'dependabot[bot]'
	run: \|
	if ! git diff --exit-code; then
	echo "::error::There are uncommitted changes after pre-commit. Please run 'pre-commit run --all-files' locally and commit the fixes."
	echo "::warning::Files with changes:"
	git diff --name-status
	exit 1
	fi

	- name: Verify if there are any new files after pre-commit
	if: github.actor != 'dependabot[bot]'
	run: \|
	unstaged_files=$(git ls-files --others --exclude-standard)
	if [ -n "$unstaged_files" ]; then
	echo "::error::There are new untracked files after pre-commit. Please run 'pre-commit run --all-files' locally and commit the fixes."
	echo "::warning::New files:"
	echo "$unstaged_files"
	exit 1
	fi

	- name: Configure client installation
	id: client-config
	uses: ./.github/actions/install-ogx-client

	- name: Sync dev + type_checking dependencies
	run: \|
	uv sync --group dev --group type_checking

	# Install specific client version after sync if needed
	if [ "${{ steps.client-config.outputs.install-after-sync }}" = "true" ]; then
	echo "Installing ogx-client from: ${{ steps.client-config.outputs.install-source }}"
	uv pip install --upgrade ${{ steps.client-config.outputs.install-source }}
	fi

	- name: Run mypy (full type_checking)
	run: \|
	set +e
	uv run --group dev --group type_checking mypy
	status=$?
	if [ $status -ne 0 ]; then
	echo "::error::Full mypy failed. Reproduce locally with 'uv run pre-commit run mypy-full --hook-stage manual --all-files'."
	fi
	exit $status

	- name: Check if any unused recordings
	run: \|
	set -e
	PYTHONPATH=$PWD uv run --group test ./scripts/cleanup_recordings.py --delete
	changes=$(git status --short tests/integration \| grep 'recordings' \|\| true)
	if [ -n "$changes" ]; then
	echo "::error::Unused integration recordings detected. Run 'PYTHONPATH=$(pwd) uv run ./scripts/cleanup_recordings.py --delete' locally and commit the deletions."
	echo "$changes"
	exit 1
	fi

Navigation Menu

Uh oh!

Run pre-commit checks #25824

Workflow file

Run pre-commit checks #25824

Uh oh!

Workflow file for this run