changelog

---
name: changelog
description: Understand auto-generated changelogs via release-please. Use when viewing release history, understanding changelog format, or debugging missing changelog entries.
---

# Changelog Skill

`CHANGELOG.md` is generated by release-please as part of each Release PR.

## How It Works

1. release-please runs on push to `main`
2. It generates notes from conventional commits since the last release
3. The notes are prepended to `CHANGELOG.md` in the open Release PR
4. Merging the Release PR commits the changelog and publishes the same notes as the GitHub Release

## Changelog Sections

Commit types map to changelog sections:

| Commit Type | Changelog Section |
|-------------|-------------------|
| `feat` | Features |
| `fix` | Bug Fixes |
| `perf` | Performance Improvements |
| `revert` | Reverts |
| `feat!` / `BREAKING CHANGE` | ⚠ BREAKING CHANGES |

Types `chore`, `docs`, `refactor`, `test`, `ci`, `build` and `style` do **not** appear in the changelog.

## Viewing Changelog

```bash
# View the changelog file
cat CHANGELOG.md

# View a specific GitHub release's notes
gh release view v5.31.0

# Preview the next entry in the open Release PR
gh pr list --label "autorelease: pending"
```

## Missing Changelog Entry?

1. Check the commit type: only `feat`, `fix`, `perf` and `revert` generate entries
2. Verify the commit landed on `main`
3. Check the Release PR has been updated: `gh run list --workflow=release.yml`
4. Ensure the commit message follows the conventional format

## File Location

- **Changelog**: `CHANGELOG.md` (root of repository)
- **Config**: `release-please-config.json`

## Related

- See `release-management` skill for release workflow