add-to-changelog

Add to Changelog

When to Use

• After completing a feature, fix, or breaking change ready for release
• Before tagging a new version — to ensure CHANGELOG is current
• During release prep — to create a new version section with today's date
• As part of commit-workflow → add-to-changelog → release pipeline

Prerequisites

• Git repository with meaningful commit history
• CHANGELOG.md exists or will be created
• Version follows Semantic Versioning (MAJOR.MINOR.PATCH)

Workflow

1. Locate or Create CHANGELOG.md

# Check if CHANGELOG exists
if (-not (Test-Path CHANGELOG.md)) {
    # Create with standard header
    @"
# 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.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
"@ | Set-Content CHANGELOG.md
}

2. Determine the Change Type

3. Add Entry to the Right Section

Option A — Add to [Unreleased] (staging for next release):

# Read current CHANGELOG
$changelog = Get-Content CHANGELOG.md -Raw

# Insert under [Unreleased] → Added section
$entry = "- Your change description here"
$changelog = $changelog -replace '(## \[Unreleased\]\s*\n)', "`$1`n### Added`n$entry`n"
Set-Content CHANGELOG.md $changelog

Option B — Create a new versioned section:

$version = "1.2.0"
$date = Get-Date -Format "yyyy-MM-dd"
$newSection = @"

## [$version] - $date

### Added
- New feature description

"@

$changelog = Get-Content CHANGELOG.md -Raw
$changelog = $changelog -replace '(## \[Unreleased\])', "$newSection`$1"
Set-Content CHANGELOG.md $changelog