zerv

Overview

Zerv is a dynamic versioning tool that integrates seamlessly with git, ensuring every commit receives a unique version. It is designed to complement semantic-release on the main branch while allowing users to utilize its prerelease capabilities across other branches. This dual functionality guarantees that no build goes unversioned, enhancing version control across development workflows.

Key Features

• Integration with Semantic-Release: Zerv runs parallel to semantic-release, which handles releases on the main branch. Zerv autonomously versions commits across all branches, including those with uncommitted changes.
• Flexible Versioning Modes:
  • Zerv Flow: Automatically manages pre-release versions based on Git branch patterns.
  • Zerv Version: Provides manual control with options for schemas, overrides, and templates.
• Diverse Output Formats: Supports various versioning formats such as SemVer, PEP440, and CalVer. Users can generate multiple formats required by their pipelines from a single ZERV RON payload.

Quick Start

To version any Git state, simply run:

zerv flow

This command generates meaningful SemVer versions according to the current branch context:

# → 1.0.0 (on main branch with tag v1.0.0)
# → 1.0.1-rc.1.post.3 (on release branch with pre-release tag)
# → 1.0.1-beta.1.post.3+develop.3.gf297dd0 (on develop branch)
# → 1.0.1-alpha.59394.post.1+feature.new.auth.1.g4e9af24 (on feature branch)
# → 1.0.1-alpha.17015.post.1.dev.1764382150+feature.dirty.work.1.g54c499a (on dirty feature branch)

Documentation

Comprehensive documentation is available at zerv.wisl.dev, featuring:

• An overview that compares Zerv with other versioning tools like semantic-release, setuptools-scm, and dunamai.
• A quickstart guide that outlines how to efficiently utilize a ZERV RON payload for diverse output formats.
• Detailed concepts on flow, versioning, schema systems, and configuration files.
• Guidelines for CI/CD integration with GitHub Actions alongside semantic-release.
• A complete reference for Zerv commands including zerv version, zerv flow, and more.
• Solutions for common troubleshooting scenarios.

Development and Contribution

Developers interested in contributing to Zerv can clone the repository and follow the standard setup process. The project also encourages contributions, providing clear development guidelines and a structured testing environment.

For more information on Zerv, visit the project documentation at zerv.wisl.dev.