Skip to content

Inconsistent git tag naming convention: 'v' prefix added in new release script #2267

@ihabadham

Description

@ihabadham

Summary

The release script introduced in PR #1856 creates git tags with a v prefix (e.g., v16.2.0.beta.1), but all historical tags from version 2.0.0 through 16.1.2 do NOT have the v prefix (e.g., 16.1.1).

This inconsistency caused a broken CHANGELOG link (fixed in PR #2263) where Claude assumed 16.1.1 should be v16.1.1 to match the new tag pattern.

Details

Old release process (16.1.1 and earlier):

  • Used release-it npm tool
  • release-it auto-detected tag format from existing tags
  • Created tags WITHOUT 'v' prefix: 16.0.0, 16.1.0, 16.1.1

New release process (16.2.0.beta.0 onwards):

Tag inventory

WITHOUT 'v' prefix (versions 2.0.0 - 16.1.2):
  2.0.0, 3.0.0, 4.0.0, ..., 16.0.0, 16.1.0, 16.1.1, 16.1.2

WITH 'v' prefix (versions 16.2.0+):
  v16.2.0.beta.0, v16.2.0.beta.1, ..., v16.2.0.rc.0

Note: Very early versions (0.x, 1.x) had mixed conventions with some 'v' prefixed tags.

Recommendation

Pick one convention and stick to it:

Option A: Remove 'v' prefix (match historical convention)

  • Change rakelib/release.rake line 254 from git tag v#{actual_gem_version} to git tag #{actual_gem_version}
  • More consistent with 9+ years of existing tags (2.0.0 through 16.1.2)

Option B: Keep 'v' prefix (new convention)

  • Document this as the new convention going forward
  • Accept that CHANGELOG links crossing the 16.1.x → 16.2.x boundary will need mixed formats

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions