Versioning Strategy¶
Overview¶
This directory contains AudioLab's versioning strategy based on Semantic Versioning 2.0.0.
Contents¶
- semantic_versioning.md - Complete guide to SemVer rules and decision tree
- version_locations.md - Where version numbers appear in codebase
- version_bump.ps1 - Automated version bumping script
- compatibility_matrix.md - Version compatibility rules
Quick Start¶
Bump Version¶
# Increment PATCH: 2.1.3 → 2.1.4
.\version_bump.ps1 patch
# Increment MINOR: 2.1.4 → 2.2.0
.\version_bump.ps1 minor
# Increment MAJOR: 2.2.0 → 3.0.0
.\version_bump.ps1 major
# Add pre-release: 3.0.0 → 3.0.0-beta.1
.\version_bump.ps1 pre-release beta.1
Version Format¶
MAJOR.MINOR.PATCH[-PRERELEASE][+BUILD]
Examples:
- 2.1.3 (Stable release)
- 2.2.0-beta.1 (Beta pre-release)
- 2.2.0-rc.2 (Release candidate)
Decision Guide¶
When to bump: - MAJOR: Breaking API changes (user code breaks) - MINOR: New features (backward compatible) - PATCH: Bug fixes (no API changes)
See semantic_versioning.md for detailed decision tree.
Related Documentation¶
../03_13_01_changelog_generation/- How versions map to changelog../03_13_05_release_validation/- Release validation checklist