changelog-authoring

Drafts user-facing changelog entries for the Unreleased section from git history and PR metadata.

9.5k|1.0k|Updated Sep 11, 2025
One-click install
npx skills add https://github.com/openchamber/openchamber --skill changelog-authoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog-authoring
Source: https://github.com/openchamber/openchamber/tree/main/.agents/skills/changelog-authoring
Command: npx skills add https://github.com/openchamber/openchamber --skill changelog-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintainers of OpenChamber write release notes once per release by hand, and this Skill turns the commits and squashed PR merges since the latest git tag into consistent, user-facing changelog bullets for both the main app and the VS Code extension.

Core Features & Use Cases

  • Git and PR context gathering: Inspects every commit and changed path since the latest tag, and pulls PR titles, descriptions, and authors via the GitHub CLI for squashed merges.
  • Dual changelog authoring: Writes ranked, impact-sorted bullets for the main CHANGELOG.md and a reachability-checked list for packages/vscode/CHANGELOG.md.
  • Style and credit enforcement: Matches existing release-note tone, bolds only headline changes, and credits contributors inline while skipping the repo owner.
  • Use Case: Before cutting a release, ask the agent to update the changelog; it reviews all commits since the last tag, drafts the [Unreleased] sections for both files, and edits them in place.

Quick Start

Ask the agent to update the changelog with entries for everything merged since the latest release tag.

Frequently Asked Questions about changelog-authoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate changelog entries from git commits?

Run git log and git diff from the latest tag to HEAD to enumerate changes, then distill each user-visible change into a plain bullet. This Skill automates that process and writes the bullets into the [Unreleased] section of CHANGELOG.md.

How do I write release notes for squashed PR merges?

Squashed merge commits often hide the real change behind a terse subject line. Fetch the original PR with gh pr view to get its title, description, and author, then distill that into a changelog-style bullet rather than copying the commit subject.

When should the changelog be updated during development?

In this workflow the changelog is updated only once per release, when the maintainer explicitly asks. Individual fixes, features, and PR merges land without changelog lines, and the maintainer folds them into the [Unreleased] section later.

How do I keep a separate changelog for a VS Code extension?

Maintain a dedicated CHANGELOG.md in the extension package and include only changes whose UI surfaces are actually mounted by the extension entrypoint. Shared code that the extension never mounts should not produce an entry, since users would report it as a bug.

What are the limitations of automated changelog generation?

Automated drafts still require maintainer judgment: internal refactors without user-visible effects should be omitted, highlights must be genuinely headline-worthy, and entries unsupported by inspected evidence should be dropped rather than guessed.