Skip to main content

Release skill

Changelog Skill

Update CHANGELOG.md from commits since the latest release.

On this page

Install command

AI DevKit installs its built-in skills as one curated set. Run this once to install changelog with the rest of the built-in workflow skills.

bash
npx ai-devkit@latest skill add --built-in

What it does

Use changelog when preparing release notes or keeping the Unreleased section current. It extracts concise changelog items from recent commits and links them back to source changes.

When to use it

  • Prepare release notes from recent commits
  • Update the Unreleased changelog section
  • Summarize implementation history for maintainers

Supported agents

  • Claude Code
  • Codex

The SKILL.md file

This is what your agent reads when the skill runs. View it on GitHub (opens in a new tab)

Update the top Unreleased list in CHANGELOG.md from commits after the latest release.

Workflow#

  1. Find the latest release base:
    • Prefer the latest reachable tag: git describe --tags --abbrev=0.
    • If there are no tags, search recent history for a release commit and use that hash.
  2. Get commits: git log <base>..HEAD --reverse --format='%H%x09%s'.
  3. Derive the GitHub repo URL from git remote get-url origin.
  4. For each commit, add one concise changelog line:
    • Format: - [<short-hash>](https://github.com/codeaholicguy/ai-devkit/blob/main/skills/changelog/<url>) <one-line summary>
    • If the commit clearly relates to a PR, link the hash to the PR URL instead of the commit URL.
    • Detect PRs from subjects like (#123), merge commits, or gh pr list --search <hash> --state all --json number,url.
  5. Insert the new lines into the top Unreleased section/list in CHANGELOG.md.
    • If no Unreleased section exists, create one at the top.
    • Do not create a dated release heading unless the user asks for a release.

Rules#

  • Keep one line per commit.
  • Preserve the existing changelog style when obvious.
  • Always add entries to the top Unreleased list.
  • Skip noisy commits only when clearly non-user-facing and explain what was skipped.
  • Do not invent PR links; use commit links when PR evidence is missing.
esc