Release¶
This repository is packaged with Hatch and publishes a wheel built from the local source tree.
Version source¶
The project version is defined in:
configurator/__about__.py
pyproject.toml reads that file through:
Recommended release workflow¶
- Update
configurator/__about__.py. - Run tests.
- Run formatting and checks.
- Build the distribution artifacts.
- Validate the generated wheel in a clean environment or container.
- Tag the release in Git.
- Publish using your internal delivery process.
Useful commands¶
Run tests:
Run checks:
Build docs:
Build the wheel:
Build the container image that installs the wheel:
Notes¶
- the Dockerfile builds a wheel in a builder stage and installs that wheel in the runtime stage
- there is no release automation documented in this repository beyond the local Hatch and Docker workflows
- if you add CI-based publishing later, update this document to describe the exact registry and tagging rules