Investigate versioning inconsistency - CHANGELOG.md ahead of git tags #143

Closed
opened 2026-01-24 17:47:57 +00:00 by lmiranda · 1 comment
Owner

Problem Description

During a documentation audit, a versioning inconsistency was discovered:

  • Git tags: Latest tag is v3.1.1
  • CHANGELOG.md: Had entry for 3.1.2 dated 2026-01-23 (never tagged/released)
  • marketplace.json: Was at 3.1.0 (behind actual release)
  • README.md title: Was correct at v3.1.1

This indicates the versioning workflow is not properly enforced.

Immediate Fixes Applied

  1. Updated marketplace.json version to 3.1.1
  2. Marked CHANGELOG.md 3.1.2 entry as [Unreleased]

Root Cause Investigation Needed

Analyze how versioning flows through the system.

Acceptance Criteria

  • Document current version locations and their relationships
  • Identify the root cause of the 3.1.2 CHANGELOG entry without tag
  • Propose a plan to prevent future version drift
  • Implement chosen solution
## Problem Description During a documentation audit, a versioning inconsistency was discovered: - **Git tags**: Latest tag is `v3.1.1` - **CHANGELOG.md**: Had entry for `3.1.2` dated 2026-01-23 (never tagged/released) - **marketplace.json**: Was at `3.1.0` (behind actual release) - **README.md title**: Was correct at `v3.1.1` This indicates the versioning workflow is not properly enforced. ## Immediate Fixes Applied 1. Updated marketplace.json version to 3.1.1 2. Marked CHANGELOG.md 3.1.2 entry as [Unreleased] ## Root Cause Investigation Needed Analyze how versioning flows through the system. ## Acceptance Criteria - [ ] Document current version locations and their relationships - [ ] Identify the root cause of the 3.1.2 CHANGELOG entry without tag - [ ] Propose a plan to prevent future version drift - [ ] Implement chosen solution
Author
Owner

Fix Implemented

Changes Made

  1. Created scripts/release.sh - Versioning workflow script that ensures consistency:

    • Validates [Unreleased] section in CHANGELOG
    • Updates CHANGELOG, README, and marketplace.json atomically
    • Creates commit and git tag
    • Interactive prompts for review before committing
  2. Fixed CHANGELOG.md - Consolidated all changes since v3.1.1 under [Unreleased]

  3. Updated CLAUDE.md - Comprehensive versioning documentation:

    • Version locations table
    • Development workflow (use [Unreleased])
    • Release workflow (use ./scripts/release.sh)
    • SemVer guidelines
  4. Released v3.2.0 - Using the new workflow:

    • Tag: v3.2.0
    • All 33 commits since v3.1.1 properly documented
    • Version consistent across all files

Create PR

https://gitea.hotserv.cloud/personal-projects/leo-claude-mktplace/compare/development...fix/issue-143-versioning-workflow

Acceptance Criteria

  • Document current version locations and their relationships
  • Identify the root cause (CHANGELOG edited before release process)
  • Propose a plan to prevent future version drift (release script)
  • Implement chosen solution (script + docs + v3.2.0 release)
## Fix Implemented ### Changes Made 1. **Created `scripts/release.sh`** - Versioning workflow script that ensures consistency: - Validates `[Unreleased]` section in CHANGELOG - Updates CHANGELOG, README, and marketplace.json atomically - Creates commit and git tag - Interactive prompts for review before committing 2. **Fixed CHANGELOG.md** - Consolidated all changes since v3.1.1 under `[Unreleased]` 3. **Updated CLAUDE.md** - Comprehensive versioning documentation: - Version locations table - Development workflow (use `[Unreleased]`) - Release workflow (use `./scripts/release.sh`) - SemVer guidelines 4. **Released v3.2.0** - Using the new workflow: - Tag: `v3.2.0` - All 33 commits since v3.1.1 properly documented - Version consistent across all files ### Create PR https://gitea.hotserv.cloud/personal-projects/leo-claude-mktplace/compare/development...fix/issue-143-versioning-workflow ### Acceptance Criteria - [x] Document current version locations and their relationships - [x] Identify the root cause (CHANGELOG edited before release process) - [x] Propose a plan to prevent future version drift (release script) - [x] Implement chosen solution (script + docs + v3.2.0 release)
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: personal-projects/leo-claude-mktplace#143