Skip to main content

Versioning scheme

Packages follow Semantic Versioning for tag naming.

The standard format is vMAJOR.MINOR.PATCH.

  • MAJOR
    • Breaking change
    • Must be discussed in advance
    • Usually triggers updates in dependent packages
  • MINOR
    • New feature
    • Backward-compatible
  • PATCH
    • Non-breaking fixes
    • Examples:
      • Typo fix
      • Comment fix
      • Fixture update

How to create an annotated tag

git tag -a v1.0.0 -m "Release version 1.0.0"
info
  • You should create tags only from release branch content.

Examples

v1.0.0 — Your first stable release.

v1.1.0 — You added a new search feature.

v1.1.1 — You fixed a typo in the search results.

v2.0.0 — You overhauled the database schema; old versions won't work.

Reference: https://semver.org/