changelog-generator-manual

Changelog Generator

Critical Rules

• Must analyze all git tags from the beginning of the repository
• Must create a chronological changelog with newest versions at the top
• Must categorize changes into Features, Bug Fixes, Breaking Changes, and Other
• Must provide a structured summary suitable for changelog documentation
• Must handle cases where no tags exist
• Must exclude merge commits and focus on meaningful changes
• Must link features and changes to their corresponding commits or PRs
• Must follow Keep a Changelog format standards
• Must include unreleased changes section for current development
• Must store the changelog.md file at the project root directory

actions:

• type: generate content: |

  Changelog Generation Process

  1. Identify All Versions:

     # Read current version from package.json
     CURRENT_VERSION=$(node -p "require('./package.json').version")
     
     # Get all git tags sorted by version
     ALL_TAGS=$(git tag --sort=-version:refname)
     
     # Get commits since last tag (unreleased changes)
     UNRELEASED_COMMITS=$(git log --oneline --no-merges $(git describe --tags --abbrev=0 2>/dev/null || echo "")..HEAD)
     
     echo "Current package.json version: $CURRENT_VERSION"
     echo "All git tags: $ALL_TAGS"
     

  2. Analyze All Version Changes:

     # For each tag, get commits since previous tag
     for tag in $ALL_TAGS; do
       PREV_TAG=$(git describe --tags --abbrev=0 $tag^ 2>/dev/null || echo "")
       COMMITS=$(git log --oneline --no-merges $PREV_TAG..$tag)
       echo "Version $tag: $COMMITS"
     done
     

  3. Categorize Changes by Type:

     • Features: feat: commits, new functionality
     • Bug Fixes: fix: commits, bug resolutions
     • Breaking Changes: BREAKING: commits, incompatible changes
     • Documentation: docs: commits, documentation updates
     • Other: chore:, refactor:, style:, test: commits