Changelog Generator
Automatically generates and maintains a project's CHANGELOG.md file by analyzing code changes, commits, or version control history to produce structured release notes.
Goal
Produce release notes
How to Run
Run this loop to automatically generate and validate release notes in your project's CHANGELOG.md file.
- 01
Initiate Loop
Start the loop by requesting the agent to generate the changelog.
- 02
Audit Changes
The agent will analyze changes and update the changelog file.
- 03
Verify Completion
Run the check command to ensure the changelog meets quality standards and contains all necessary information.
Workflow Steps
- 01
Collect Changes
Gather all changes from the current development cycle using git history or change files.
- 02
Categorize Changes
Sort changes into appropriate categories like Added, Changed, Fixed, etc.
- 03
Format Entries
Write formatted changelog entries following the standard structure.
- 04
Update Changelog File
Append new entries to CHANGELOG.md under the correct version header.
- 05
Audit Changelog
Run the check command to verify completeness and formatting.
Kickoff Prompt
Start the "Changelog Generator" loop. Goal: Produce release notes Max iterations: 10 Between iterations run: changelog audit Exit when: Changelog complete Please generate the next set of release notes for the upcoming version. Analyze recent commits, changes, and updates to create a properly formatted changelog entry following the Keep a Changelog format. Self-pace this loop. After each iteration, run `changelog audit` and evaluate the output, and only continue if the exit condition is not met (Changelog complete). Stop when the exit condition passes or 10 iterations are reached. Give a short status update each pass.
Guardrails
hardcoded- ·Ensure the changelog follows [Keep a Changelog](https://keepachangelog.com/) format.
- ·Validate no duplicate entries exist for the same version.
- ·Check that all entries are categorized under appropriate headers (Added, Changed, Deprecated, Removed, Fixed, Security).
- ·Confirm the changelog file is properly updated with the latest version number and release date.
Flow Diagram
Related loops — Docs
Docs
Example Coverage Builder
Automatically identifies areas in your codebase lacking usage examples and iteratively adds them to improve documentation coverage. The agent focuses on generating practical, copy-paste-friendly examples for functions, methods, and components that currently lack adequate documentation.
Docs
API Docs Sync
Automatically synchronizes API documentation with the codebase to ensure no drift occurs between implementation and documented interfaces. This loop detects discrepancies, generates necessary updates, and applies them while respecting guardrails to maintain consistency and quality.
Docs
Docs Until Complete
This loop identifies and documents all missing features in a codebase to achieve full documentation coverage. It systematically audits the existing documentation, finds gaps, and fills them with appropriate documentation until the audit passes.