Expand Ruff quality rules #158

Workflow file for this run

.github/workflows/package.yml at 6438a00

	name: Package

	on:
	pull_request:
	paths:
	- "lib/python/base_cli/**"
	- "pyproject.toml"
	- "VERSION"
	- "README.md"
	- "LICENSE"
	- "MANIFEST.in"
	- "scripts/validate_package_artifact.py"
	- "scripts/validate_installed_package.py"
	- "scripts/validate_examples.py"
	- "examples/**"
	- "compatibility/**"
	- "docs/releasing.md"
	- ".github/workflows/package.yml"
	push:
	branches:
	- main
	tags:
	- "v*"
	workflow_dispatch:
	inputs:
	publish_target:
	description: "Protected publication target"
	required: true
	type: choice
	options:
	- testpypi
	- pypi
	default: testpypi

	permissions:
	contents: read

	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: true

	env:
	PACKAGE_NAME: base-cli

	jobs:
	build:
	name: Build and validate distributions
	runs-on: ubuntu-latest
	timeout-minutes: 10
	outputs:
	version: ${{ steps.metadata.outputs.version }}
	steps:
	- name: Check out source
	uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

	- name: Set up Python
	uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
	with:
	python-version: "3.13"

	- name: Read package version
	id: metadata
	run: echo "version=$(tr -d '\\r\\n' < VERSION)" >> "$GITHUB_OUTPUT"

	- name: Validate release ref
	env:
	PUBLISH_TARGET: ${{ inputs.publish_target \|\| '' }}
	run: \|
	if [[ "$GITHUB_REF_TYPE" == "tag" && "$GITHUB_REF_NAME" != "v${{ steps.metadata.outputs.version }}" ]]; then
	echo "Release tag must be v${{ steps.metadata.outputs.version }}; got $GITHUB_REF_NAME" >&2
	exit 1
	fi
	if [[ "$PUBLISH_TARGET" == "pypi" && "$GITHUB_REF_TYPE" != "tag" ]]; then
	echo "PyPI publication requires dispatching this workflow from the matching version tag." >&2
	exit 1
	fi

	- name: Validate repository baseline
	run: ./tests/validate.sh

	- name: Prepare clean artifact destination
	run: \|
	git clean -ffdx
	mkdir -p dist

	- name: Install build and validation tools
	run: python -m pip install --upgrade build twine

	- name: Build sdist and wheel
	run: python -m build --sdist --wheel --outdir dist

	- name: Validate artifact contents and metadata
	run: python scripts/validate_package_artifact.py dist

	- name: Validate package indexes
	run: python -m twine check dist/*

	- name: Upload reviewed distributions
	uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
	with:
	name: base-cli-dist-${{ github.run_id }}
	path: dist/*
	if-no-files-found: error
	retention-days: 14

	smoke:
	name: Install smoke test (Python ${{ matrix.python-version }})
	needs: build
	runs-on: ubuntu-latest
	timeout-minutes: 10
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
	steps:
	- name: Check out source
	uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

	- name: Set up Python
	uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
	with:
	python-version: ${{ matrix.python-version }}

	- name: Download reviewed distributions
	uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
	with:
	name: base-cli-dist-${{ github.run_id }}
	path: dist

	- name: Install wheel and runtime dependencies
	run: python -m pip install dist/base_cli-*.whl

	- name: Verify installed package
	env:
	EXPECTED_VERSION: ${{ needs.build.outputs.version }}
	run: \|
	python - <<'PY'
	import base_cli
	import importlib.metadata

	expected = __import__("os").environ["EXPECTED_VERSION"]
	assert base_cli.__version__ == expected, (base_cli.__version__, expected)
	assert importlib.metadata.version("base-cli") == expected
	assert hasattr(base_cli, "App")
	print(f"base-cli {base_cli.__version__} installed successfully")
	PY

	- name: Exercise installed wheel API and lifecycle
	env:
	EXPECTED_VERSION: ${{ needs.build.outputs.version }}
	run: python -I scripts/validate_installed_package.py

	- name: Check installed dependency consistency
	run: python -m pip check

	publish:
	name: Publish reviewed distribution
	needs: [build, smoke]
	if: ${{ (github.event_name == 'push' && github.ref_type == 'tag') \|\| github.event_name == 'workflow_dispatch' }}
	runs-on: ubuntu-latest
	timeout-minutes: 10
	environment:
	name: ${{ github.event_name == 'push' && 'pypi' \|\| inputs.publish_target }}
	url: ${{ github.event_name == 'push' && 'https://pypi.org/p/base-cli' \|\| 'https://test.pypi.org/p/base-cli' }}
	permissions:
	contents: read
	id-token: write
	steps:
	- name: Download reviewed distributions
	uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
	with:
	name: base-cli-dist-${{ github.run_id }}
	path: dist

	- name: Publish to TestPyPI
	if: ${{ github.event_name == 'workflow_dispatch' && inputs.publish_target == 'testpypi' }}
	uses: pypa/gh-action-pypi-publish@4bb033805d9e19112d8c697528791ff53f6c2f74
	with:
	packages-dir: dist
	repository-url: https://test.pypi.org/legacy/

	- name: Publish to PyPI
	if: ${{ (github.event_name == 'push' && github.ref_type == 'tag') \|\| (github.event_name == 'workflow_dispatch' && inputs.publish_target == 'pypi') }}
	uses: pypa/gh-action-pypi-publish@4bb033805d9e19112d8c697528791ff53f6c2f74
	with:
	packages-dir: dist

Navigation Menu

Expand Ruff quality rules #158

Workflow file

Expand Ruff quality rules #158

Uh oh!

Workflow file for this run