changelog-manager

Changelog Manager

Quick Start

Create or update a changelog:

# Review recent commits
git log --oneline --since="2024-01-01"

# Check current version
cat package.json | grep version

Instructions

Step 1: Review Changes

Gather changes since last release:

# Get commits since last tag
git log $(git describe --tags --abbrev=0)..HEAD --oneline

# Or since specific date
git log --since="2024-01-01" --pretty=format:"%s"

Step 2: Categorize Changes

Group by type following Keep a Changelog:

Category	Description	Examples
Added	New features	New API endpoint, new command
Changed	Changes to existing	Updated algorithm, changed default
Deprecated	Soon-to-be removed	Old API marked deprecated
Removed	Removed features	Deleted unused function
Fixed	Bug fixes	Fixed crash, corrected calculation
Security	Security fixes	Patched vulnerability

Step 3: Format Entry

Follow Keep a Changelog format:

## [Version] - YYYY-MM-DD

### Added
- New feature description
- Another new feature

### Changed
- Modified behavior description

### Fixed
- Bug fix description

Step 4: Update CHANGELOG.md

Add new entry at the top (after "Unreleased"):

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [2.1.0] - 2024-01-15

### Added
- User authentication with JWT tokens
- Rate limiting for API endpoints

### Changed
- Updated database schema for better performance
- Improved error messages

### Fixed
- Fixed memory leak in background worker
- Corrected timezone handling in reports

## [2.0.0] - 2023-12-01

### Added
- Complete API rewrite
- GraphQL support

### Changed
- **BREAKING**: New authentication system

### Removed
- Legacy v1 API endpoints