1
# Changelog Generator
2
3
Turns a git commit range into a grouped `CHANGELOG.md` entry following the
4
[Keep a Changelog](https://keepachangelog.com/) format: Breaking Changes, Added, Fixed,
5
and Performance sections, each entry linked back to its issue/PR/commit. Works best on
6
history following Conventional Commits, but classifies unstructured commits too.
7
8
## When to use
9
10
- Cutting a release and need a changelog entry without manually re-reading every
11
  commit in the range.
12
- Generating release notes for a tag before publishing.
13
- Maintaining an `Unreleased` section incrementally as PRs merge.
14
15
## Install
16
17
```bash
18
npx openagents-cli add openagents/changelog-generator
19
```
20
21
| Runtime | Installed to |
22
|---|---|
23
| `claude-code` | `.claude/skills/changelog-generator/` |
24
| `codex` | `.codex/skills/changelog-generator/` |
25
| `generic` | `.openagents/changelog-generator/` |
26
27
## Inputs
28
29
| name | type | required | default | description |
30
|---|---|---|---|---|
31
| `from_ref` | string | yes | — | Starting git ref (exclusive), e.g. the previous release tag |
32
| `to_ref` | string | no | `HEAD` | Ending git ref (inclusive) |
33
| `version` | string | no | — | Version label for the new section; left as "Unreleased" if omitted |
34
35
## Example run
36
37
```
38
> Generate a changelog entry from v1.2.0 to HEAD, label it 1.3.0.
39
```
40
41
The agent walks `git log v1.2.0..HEAD`, classifies each commit (feat/fix/perf/breaking),
42
merges related commits, links each entry to its issue/PR where determinable, and
43
inserts a `## [1.3.0] - 2026-09-09` section at the top of `CHANGELOG.md`.
44
45
## Files
46
47
- `WORKFLOW.md` — the step-by-step procedure (entry point).
48
49
## Related
50
51
- `openagents/commit-conventions` — a Conventional Commits rules set that makes this
52
  generator's classification far more reliable; listed as a soft `requires`.
53
54
## Limitations
55
56
- Classification quality depends on commit message quality; unstructured history is
57
  still processed but with best-effort (not guaranteed-accurate) type inference.
58
- Link generation needs a recognizable git remote URL (GitHub/GitLab-style) and,
59
  ideally, the `gh` CLI for PR lookups; otherwise links fall back to raw commit SHAs.
60
- Ranges over ~150 commits are summarized by theme rather than fully enumerated, to
61
  keep the entry readable.
62