Skip to content

Fix: CHANGELOG consistency and generation issues #75

Description

@bniladridas

Summary

Fixed CHANGELOG.md formatting inconsistencies and the release workflow that was generating broken changelog entries.

Issues Fixed

1. CHANGELOG.md Formatting

  • Problem: v1.8.4 had malformed entries with duplicate sections, orphaned text (# CHANGELOG), and no proper categorization
  • Fix: Rewrote entire changelog with consistent ### Fix, ### Feature, ### Chore, etc. sections

2. Missing Versions

  • Problem: 20 versions (v1.6.6 - v1.8.3) were missing from changelog
  • Fix: Added placeholder entries for all missing versions

3. Release Workflow (release.yml)

  • Problem: Generated flat list of entries with - bullets, no categorization
  • Fix: Now outputs proper sections:
    ## v1.8.5 (2026-03-23)
    
    ### Fix
    * fix: some fix
    * fix: another fix
    
    ### Feature
    * feat: new feature

4. Enhance Script (enhance_changelog.py)

  • Problem: Created nested brackets like [[#123](url)] when issue refs already existed
  • Fix: Now only matches standalone #123 patterns, avoids [, (, ), ] characters

Evidence

=== Versions match ===
Git tags:       53
Changelog versions:       53
All versions match!

=== Evidence: Workflow format ===
              echo "### Fix" >> /tmp/new_entries.md
              echo "$FIXES" | sed 's/^[a-f0-9]* /\* /' >> /tmp/new_entries.md

=== Evidence: Enhance script safe ===
    pattern = r"(?<![[])(?<!\()#(\d+)(?!\))(?!\])"

Files Changed

  • .github/workflows/release.yml - Fixed changelog generation
  • scripts/enhance_changelog.py - Fixed issue link pattern
  • CHANGELOG.md - Reformatted and added missing versions

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