git-version-sync

A CLI tool to synchronize semantic versions between Git tags and project configuration files.

Links: Repository · PyPI · npm · Issues

Quick Start

# Install (choose one)
pip install git-version-sync        # Python/PyPI
npm install -g git-version-sync     # Node.js/npm

# Use it
cd your-project
git-version-sync bump               # Interactive bump
git-version-sync bump -p -r         # Bump + push + release

Features

• Check version status and consistency
• Sync version discrepancies between config and Git tags
• Bump versions (major, minor, patch, auto) with semantic versioning
• Push to remote with optional GitHub releases
• Undo version bumps with automatic rollback on error
• Auto-detect multiple config files (pyproject.toml, package.json, Cargo.toml, docker-compose.yaml, and more)
• Auto-generate changelog from conventional commits
• Multi-config support - bump multiple files atomically
• Protected branches aware with automatic rollback
• Dry-run mode to preview before executing

Documentation

Topic	Link
Installation	PyPI, npm, from source
Configuration	Supported files, auto-detection
Usage	Commands reference
Examples	Single-config, multi-config, GitHub releases
Troubleshooting	Common issues and solutions

Common Commands

# Check version status
git-version-sync check

# Bump and preview
git-version-sync bump --dry-run

# Bump + push to remote
git-version-sync bump minor -p

# Bump + push + create GitHub release
git-version-sync bump minor -p -r "New features"

# Undo last bump
git-version-sync undo

License

MIT - See LICENSE file for details

Author

Finsa-SC