Guides¶
This section contains task-oriented how-to guides for gitversioned. Unlike the Getting Started section, which is structured as a linear onboarding path, these guides are standalone — jump to whichever one is relevant to your current task.
Available Guides¶
Templates & Formatting
A deep dive into formatting strings, output file generation, and the rich build context available for template evaluation.
Configuration
A deep dive into all configuration options, file formats, and environment variables supported by gitversioned.
Hatchling Integration
Step-by-step instructions for integrating gitversioned natively with the Hatchling build backend.
Setuptools Integration
Step-by-step instructions for integrating gitversioned natively with the Setuptools build backend.
Maturin Integration
Step-by-step instructions for integrating gitversioned natively with the Maturin build backend.
Concepts & Resolution
A deep dive into how gitversioned resolves sources, determines environments, and calculates auto-increments.
Command-Line Interface (CLI)
A task-oriented guide on how to use gitversioned from the command line, with examples for pre-build invocation and Docker integration.
Python API
Instructions and code examples showing how to import and use the programmatic Python API of gitversioned in scripts.
Contributing a Guide
Have a workflow or pattern worth documenting? See the Contributing Guide to learn how to add a new guide to this section.