release

Release

Bump the version, run tests, commit, push, and publish to PyPI.

The first argument is the bump type: patch (default), minor, or major. Everything after the bump type is used as the commit message body. If no message is provided, generate one from the staged and unstaged changes.

Steps

1. Preflight checks

Verify the working tree is ready for release. Stop immediately if any check fails.

# Must be on main
[ "$(git branch --show-current)" = "main" ] || { echo "ERROR: not on main"; exit 1; }

# Working tree must be clean (no staged or unstaged changes)
git diff --quiet && git diff --cached --quiet || { echo "ERROR: dirty working tree"; exit 1; }

2. Determine version bump

Parse $ARGUMENTS for the bump type. Default to patch if not specified or if the first word isn't patch/minor/major.

Read the current version from pyproject.toml and compute the new version:

• patch: 0.1.7 → 0.1.8
• minor: 0.1.7 → 0.2.0
• major: 0.1.7 → 1.0.0

Verify the tag v{new_version} does not already exist:

git tag -l "v{new_version}" | grep -q . && { echo "ERROR: tag v{new_version} already exists"; exit 1; }

3. Run tests

uv run pytest

Stop immediately if any tests fail. This covers:

• All unit tests
• Doc-accuracy checks (tool/resource counts, licence attribution, version consistency)

4. Live smoke test (optional)

uv run pytest -m live --live -v

This runs tests/test_live_smoke.py and tests/test_arcgis_smoke.py against real government APIs. Stop if any assertion fails.

Skip if the APIs are down or you're releasing a docs-only change.

5. Build

Build early so a failure doesn't leave a tagged commit with no PyPI release.

rm -rf dist && uv build

6. Bump version and update changelog

Edit pyproject.toml to set the new version. Then update the lockfile:

uv lock && uv sync

Add a new entry to CHANGELOG.md at the top (below the header). Follow the existing format: