OpenParable
Skip to content
← Back to skills

Generate Changelog

Business
generate-changelog

Generate Changelog is an Agent Skill for business published in the deepsense-ai/ragbits repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Generate changelog entries for packages changed on the current branch.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/deepsense-ai/ragbits/blob/HEAD/.claude/skills/generate-changelog/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/generate-changelog, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Generate Changelog Entries

Generate concise changelog entries for each package with changes on the current branch compared to main, and insert them into the package CHANGELOG.md files.

Current Branch State

Changed files: !git fetch origin main 2>/dev/null; git diff --name-only origin/main 2>/dev/null

Commit messages (check for Changelog-ignore directives): !git log --pretty=format:'%B---' origin/main..HEAD 2>/dev/null

Diff for all packages: !git diff origin/main -- packages/ 2>/dev/null

Package Detection

From the changed files above, determine which packages need entries:

  1. Files matching packages/<name>/src/** mean <name> is changed — extract the second path component as the package name.
  2. If ANY file starts with typescript/, treat ragbits-chat as a changed package.
  3. Ignore files outside packages/*/src/ and typescript/ (docs, scripts, CI, etc.).

Changelog-Ignore

Check the full commit messages for lines matching Changelog-ignore: <package-name>. Skip any listed package entirely.

For Each Package

1. Read existing CHANGELOG.md

Read packages/<package>/CHANGELOG.md. Look at existing entries to understand the style used in this package.

2. Generate entry

Using the commit messages and the package diff above, write a changelog entry following these rules:

  • Start with a category prefix: feat:, fix:, refactor:, docs:, test:, chore:, etc.
  • Single concise line describing the main user-facing change
  • Focus on what changed for users, not internal implementation details
  • If there are multiple significant changes, create one entry per distinct change
  • Match the style of existing entries in the CHANGELOG

3. Insert into CHANGELOG.md

Edit packages/<package>/CHANGELOG.md — add entries after ## Unreleased as bullet points:

## Unreleased

- <new entry here>

Summary

After all packages are processed, report:

  • Packages with generated entries (and what they are)
  • Packages skipped due to Changelog-ignore
  • Packages with no meaningful user-facing changes